appium-adb 12.11.0 → 12.12.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [12.12.1](https://github.com/appium/appium-adb/compare/v12.12.0...v12.12.1) (2025-01-25)
+
+### Miscellaneous Chores
+
+* Only keep common functions in helpers ([#792](https://github.com/appium/appium-adb/issues/792)) ([18e7919](https://github.com/appium/appium-adb/commit/18e7919a812b4c1f9078e302ec75b5c86771314a))
+
+## [12.12.0](https://github.com/appium/appium-adb/compare/v12.11.0...v12.12.0) (2025-01-24)
+
+### Features
+
+* add screenState=SCREEN_STATE_OFF as the screen locked ([#791](https://github.com/appium/appium-adb/issues/791)) ([6f6f45a](https://github.com/appium/appium-adb/commit/6f6f45adcd520e8ae369e0735bafd4613c5cc6a1))
+
 ## [12.11.0](https://github.com/appium/appium-adb/compare/v12.10.3...v12.11.0) (2025-01-11)
 
 ### Features

package/build/lib/helpers.d.ts

@@ -13,87 +13,11 @@ export function getSdkRootFromEnv(): string | undefined;
  * pointing to an invalid file system entry
  */
 export function requireSdkRoot(customRoot?: string | null): Promise<string>;
-/**
- * Retrieve the path to the recent installed Android platform.
- *
- * @param {string} sdkRoot
- * @return {Promise<import('./tools/types').PlatformInfo>} The resulting path to the newest installed platform.
- */
-export function getAndroidPlatformAndPath(sdkRoot: string): Promise<import("./tools/types").PlatformInfo>;
 /**
  * @param {string} zipPath
  * @param {string} dstRoot
  */
 export function unzipFile(zipPath: string, dstRoot?: string): Promise<void>;
-/**
- * Unsigns the given apk by removing the
- * META-INF folder recursively from the archive.
- * !!! The function overwrites the given apk after successful unsigning !!!
- *
- * @param {string} apkPath The path to the apk
- * @returns {Promise<boolean>} `true` if the apk has been successfully
- * unsigned and overwritten
- * @throws {Error} if there was an error during the unsign operation
- */
-export function unsignApk(apkPath: string): Promise<boolean>;
-/**
- * @param {string} stdout
- * @returns {string[]}
- */
-export function getIMEListFromOutput(stdout: string): string[];
-/**
- * Get the absolute path to apksigner tool
- *
- * @param {Object} sysHelpers - An instance containing systemCallMethods helper methods
- * @returns {Promise<string>} An absolute path to apksigner tool.
- * @throws {Error} If the tool is not present on the local file system.
- */
-export function getApksignerForOs(sysHelpers: any): Promise<string>;
-/**
- * Get the absolute path to apkanalyzer tool.
- * https://developer.android.com/studio/command-line/apkanalyzer.html
- *
- * @param {Object} sysHelpers - An instance containing systemCallMethods helper methods
- * @returns {Promise<string>} An absolute path to apkanalyzer tool.
- * @throws {Error} If the tool is not present on the local file system.
- */
-export function getApkanalyzerForOs(sysHelpers: any): Promise<string>;
-/**
- * Checks mShowingLockscreen or mDreamingLockscreen in dumpsys output to determine
- * if lock screen is showing
- *
- * A note: `adb shell dumpsys trust` performs better while detecting the locked screen state
- * in comparison to `adb dumpsys window` output parsing.
- * But the trust command does not work for `Swipe` unlock pattern.
- *
- * In some Android devices (Probably around Android 10+), `mShowingLockscreen` and `mDreamingLockscreen`
- * do not work to detect lock status. Instead, keyguard preferences helps to detect the lock condition.
- * Some devices such as Android TV do not have keyguard, so we should keep
- * screen condition as this primary method.
- *
- * @param {string} dumpsys - The output of dumpsys window command.
- * @return {boolean} True if lock screen is showing.
- */
-export function isShowingLockscreen(dumpsys: string): boolean;
-/**
- * Check the current device power state to determine if it is locked
- *
- * @param {string} dumpsys The `adb shell dumpsys power` output
- * @returns {boolean} True if lock screen is shown
- */
-export function isInDozingMode(dumpsys: string): boolean;
-export function isCurrentFocusOnKeyguard(dumpsys: any): boolean;
-export function getSurfaceOrientation(dumpsys: any): number | null;
-export function isScreenOnFully(dumpsys: any): boolean;
-/**
- * Builds command line representation for the given
- * application startup options
- *
- * @param {StartCmdOptions} startAppOptions - Application options mapping
- * @param {number} apiLevel - The actual OS API level
- * @returns {string[]} The actual command line array
- */
-export function buildStartCmd(startAppOptions: StartCmdOptions, apiLevel: number): string[];
 /**
  * Transforms given options into the list of `adb install.install-multiple` command arguments
  *
@@ -102,95 +26,6 @@ export function buildStartCmd(startAppOptions: StartCmdOptions, apiLevel: number
  * @returns {string[]} The array of arguments
  */
 export function buildInstallArgs(apiLevel: number, options?: InstallOptions): string[];
-/**
- * Parses apk strings from aapt tool output
- *
- * @param {string} rawOutput The actual tool output
- * @param {string} configMarker The config marker. Usually
- * a language abbreviation or `(default)`
- * @returns {Object} Strings ids to values mapping. Plural
- * values are represented as arrays. If no config found for the
- * given marker then an empty mapping is returned.
- */
-export function parseAaptStrings(rawOutput: string, configMarker: string): any;
-/**
- * Parses apk strings from aapt2 tool output
- *
- * @param {string} rawOutput The actual tool output
- * @param {string} configMarker The config marker. Usually
- * a language abbreviation or an empty string for the default one
- * @returns {Object} Strings ids to values mapping. Plural
- * values are represented as arrays. If no config found for the
- * given marker then an empty mapping is returned.
- */
-export function parseAapt2Strings(rawOutput: string, configMarker: string): any;
-/**
- * Formats the config marker, which is then passed to parse.. methods
- * to make it compatible with resource formats generated by aapt(2) tool
- *
- * @param {Function} configsGetter The function whose result is a list
- * of apk configs
- * @param {string?} desiredMarker The desired config marker value
- * @param {string} defaultMarker The default config marker value
- * @return {Promise<string>} The formatted config marker
- */
-export function formatConfigMarker(configsGetter: Function, desiredMarker: string | null, defaultMarker: string): Promise<string>;
-/**
- * Transforms the given language and country abbreviations
- * to AVD arguments array
- *
- * @param {?string} language Language name, for example 'fr'
- * @param {?string} country Country name, for example 'CA'
- * @returns {Array<string>} The generated arguments. The
- * resulting array might be empty if both arguments are empty
- */
-export function toAvdLocaleArgs(language: string | null, country: string | null): Array<string>;
-/**
- * Retrieves the full path to the Android preferences root
- *
- * @returns {Promise<string?>} The full path to the folder or `null` if the folder cannot be found
- */
-export function getAndroidPrefsRoot(): Promise<string | null>;
-/**
- * Check if a path exists on the filesystem and is a directory
- *
- * @param {string} location The full path to the directory
- * @returns {Promise<boolean>}
- */
-export function dirExists(location: string): Promise<boolean>;
-/**
- * Escapes special characters in command line arguments.
- * This is needed to avoid possible issues with how system `spawn`
- * call handles them.
- * See https://discuss.appium.io/t/how-to-modify-wd-proxy-and-uiautomator2-source-code-to-support-unicode/33466
- * for more details.
- *
- * @param {string} arg Non-escaped argument string
- * @returns The escaped argument
- */
-export function escapeShellArg(arg: string): string;
-/**
- * Parses the name of launchable package activity
- * from dumpsys output.
- *
- * @param {string} dumpsys the actual dumpsys output
- * @returns {string[]} Either the fully qualified
- * activity name as a single list item or an empty list if nothing could be parsed.
- * In Android 6 and older there is no reliable way to determine
- * the category name for the given activity, so this API just
- * returns all activity names belonging to 'android.intent.action.MAIN'
- * with the expectation that the app manifest could be parsed next
- * in order to determine category names for these.
- */
-export function parseLaunchableActivityNames(dumpsys: string): string[];
-/**
- * Check if the given string is a valid component name
- *
- * @param {string} classString The string to verify
- * @return {RegExpExecArray?} The result of Regexp.exec operation
- * or _null_ if no matches are found
- */
-export function matchComponentName(classString: string): RegExpExecArray | null;
 /**
  * Extracts various package manifest details
  * from the given application file.
@@ -203,7 +38,6 @@ export function readPackageManifest(this: import("./adb.js").ADB, apkPath: strin
 export const APKS_EXTENSION: ".apks";
 export const APK_EXTENSION: ".apk";
 export const APK_INSTALL_TIMEOUT: 60000;
-export const APKS_INSTALL_TIMEOUT: number;
 export const DEFAULT_ADB_EXEC_TIMEOUT: 20000;
 /**
  * Calculates the absolsute path to the given resource
@@ -217,22 +51,6 @@ export const getResourcePath: ((relPath: any) => Promise<string>) & _.MemoizedFu
 export const getJavaHome: () => Promise<string>;
 /** @type {() => Promise<string>} */
 export const getJavaForOs: () => Promise<string>;
-/** @type {() => Promise<string>} */
-export const getOpenSslForOs: () => Promise<string>;
-/** @type {() => Promise<{major: number, minor: number, build: number}?>} */
-export const getSdkToolsVersion: () => Promise<{
-    major: number;
-    minor: number;
-    build: number;
-} | null>;
-/**
- * Retrieves full paths to all 'build-tools' subfolders under the particular
- * SDK root folder
- *
- * @type {(sdkRoot: string) => Promise<string[]>}
- */
-export const getBuildToolsDirs: (sdkRoot: string) => Promise<string[]>;
-export function extractMatchingPermissions(dumpsysOutput: string, groupNames: string[], grantedState?: boolean | null): string[];
 export type InstallOptions = {
     /**
      * - Set to true in order to allow test
@@ -263,16 +81,5 @@ export type InstallOptions = {
      */
     partialInstall?: boolean | undefined;
 };
-export type StartCmdOptions = {
-    user?: string | number | undefined;
-    waitForLaunch?: boolean | undefined;
-    pkg?: string | undefined;
-    activity?: string | undefined;
-    action?: string | undefined;
-    category?: string | undefined;
-    stopApp?: boolean | undefined;
-    flags?: string | undefined;
-    optionalIntentArguments?: string | undefined;
-};
 import _ from 'lodash';
 //# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/helpers.js"],"names":[],"mappings":"AA6DA;;;;GAIG;AACH,qCAFY,MAAM,GAAC,SAAS,CAI3B;AAED;;;;;;;GAOG;AACH,4CALW,MAAM,OAAC,GACN,OAAO,CAAC,MAAM,CAAC,CAmB1B;AAED;;;;;GAKG;AACH,mDAHW,MAAM,GACL,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CAoCxD;AAED;;;GAGG;AACH,mCAHW,MAAM,YACN,MAAM,iBAOhB;AAED;;;;;;;;;GASG;AACH,mCALW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CA8B5B;AAED;;;GAGG;AACH,6CAHW,MAAM,GACJ,MAAM,EAAE,CAWpB;AAmDD;;;;;;GAMG;AACH,oDAHa,OAAO,CAAC,MAAM,CAAC,CAK3B;AAED;;;;;;;GAOG;AACH,sDAHa,OAAO,CAAC,MAAM,CAAC,CAK3B;AAED;;;;;;;;;;;;;;;GAeG;AACH,6CAHW,MAAM,GACL,OAAO,CAMlB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,OAAO,CAMnB;AAKD,gEAGC;AAKD,mEAGC;AAMD,uDAIC;AAED;;;;;;;GAOG;AACH,+CAJW,eAAe,YACf,MAAM,GACJ,MAAM,EAAE,CAwCpB;AAqHD;;;;;;GAMG;AACH,2CAJW,MAAM,YACN,cAAc,GACZ,MAAM,EAAE,CA6BpB;AACD;;;;;;;;;GASG;AACH,4CAPW,MAAM,gBACN,MAAM,OA0EhB;AAED;;;;;;;;;GASG;AACH,6CAPW,MAAM,gBACN,MAAM,OA8GhB;AAED;;;;;;;;;GASG;AACH,2EAJW,MAAM,OAAC,iBACP,MAAM,GACL,OAAO,CAAC,MAAM,CAAC,CAmB1B;AAED;;;;;;;;GAQG;AACH,0CALY,MAAM,OAAA,WACN,MAAM,OAAA,GACL,KAAK,CAAC,MAAM,CAAC,CAuBzB;AAED;;;;GAIG;AACH,uCAFa,OAAO,CAAC,MAAM,OAAC,CAAC,CAuB5B;AAED;;;;;GAKG;AACH,oCAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;;;;;;;GASG;AACH,oCAHW,MAAM,UAShB;AAED;;;;;;;;;;;;GAYG;AACH,sDATW,MAAM,GACJ,MAAM,EAAE,CA4EpB;AAED;;;;;;GAMG;AACH,gDAJW,MAAM,GACL,eAAe,OAAC,CAM3B;AAED;;;;;;;GAOG;AACH,2EAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC,CAmHxD;AA1hCD,6BAA8B,OAAO,CAAC;AACtC,4BAA6B,MAAM,CAAC;AACpC,kCAAmC,KAAK,CAAC;AACzC,0CAA4D;AAC5D,uCAAwC,KAAK,CAAC;AA+B9C;;;;;;GAMG;AACH,uFAQG;AA8IH,oCAAoC;AACpC,0BADW,MAAM,OAAO,CAAC,MAAM,CAAC,CAc7B;AAEH,oCAAoC;AACpC,2BADW,MAAM,OAAO,CAAC,MAAM,CAAC,CAqB7B;AAEH,oCAAoC;AACpC,8BADW,MAAM,OAAO,CAAC,MAAM,CAAC,CAQ9B;AAqIF,4EAA4E;AAC5E,iCADW,MAAM,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,OAAC,CAAC,CAuBrE;AAEH;;;;;GAKG;AACH,gCAFU,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CA4B7C;AAWI,0DANI,MAAM,cACN,MAAM,EAAE,iBACR,OAAO,OAAC,GAEN,MAAM,EAAE,CA+CpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA3ea,QAAQ"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/helpers.js"],"names":[],"mappings":"AAuDA;;;;GAIG;AACH,qCAFY,MAAM,GAAC,SAAS,CAI3B;AAED;;;;;;;GAOG;AACH,4CALW,MAAM,OAAC,GACN,OAAO,CAAC,MAAM,CAAC,CAmB1B;AAED;;;GAGG;AACH,mCAHW,MAAM,YACN,MAAM,iBAOhB;AAyCD;;;;;;GAMG;AACH,2CAJW,MAAM,YACN,cAAc,GACZ,MAAM,EAAE,CA6BpB;AAED;;;;;;;GAOG;AACH,2EAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC,CAmHxD;AAlSD,6BAA8B,OAAO,CAAC;AACtC,4BAA6B,MAAM,CAAC;AACpC,kCAAmC,KAAK,CAAC;AACzC,uCAAwC,KAAK,CAAC;AA6B9C;;;;;;GAMG;AACH,uFAQG;AA+CH,oCAAoC;AACpC,0BADW,MAAM,OAAO,CAAC,MAAM,CAAC,CAc7B;AAEH,oCAAoC;AACpC,2BADW,MAAM,OAAO,CAAC,MAAM,CAAC,CAqB7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAtIW,QAAQ"}