appium-uiautomator2-driver 3.6.0 → 3.7.0

package/lib/commands/clipboard.js

@@ -0,0 +1,55 @@
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @returns {Promise<string>} Base64-encoded content of the clipboard
+ * or an empty string if the clipboard is empty.
+ */
+export async function getClipboard() {
+  return String(
+    (await this.adb.getApiLevel()) < 29
+      ? await this.uiautomator2.jwproxy.command(
+          '/appium/device/get_clipboard',
+          'POST',
+          {}
+        )
+      : await this.settingsApp.getClipboard()
+  );
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @returns {Promise<string>} Base64-encoded content of the clipboard
+ * or an empty string if the clipboard is empty.
+ */
+export async function mobileGetClipboard() {
+  return await this.getClipboard();
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @param {string} content Base64-encoded clipboard payload
+ * @param {'plaintext'} [contentType='plaintext'] Only a single
+ * content type is supported, which is 'plaintext'
+ * @param {string} [label] Optinal label to identify the current
+ * clipboard payload
+ * @returns {Promise<void>}
+ */
+export async function setClipboard(content, contentType, label) {
+  await this.uiautomator2.jwproxy.command(
+    '/appium/device/set_clipboard',
+    'POST',
+    {content, contentType, label}
+  );
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @param {import('./types').SetClipboardOpts} opts
+ * @returns {Promise<void>}
+ */
+export async function mobileSetClipboard(opts) {
+  await this.setClipboard(opts.content, opts.contentType, opts.label);
+}
+
+/**
+ * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
+ */

package/lib/commands/execute.js

@@ -49,6 +49,9 @@ export function mobileCommandsMapping() {
     scheduleAction: 'mobileScheduleAction',
     getActionHistory: 'mobileGetActionHistory',
     unscheduleAction: 'mobileUnscheduleAction',
+
+    setClipboard: 'mobileSetClipboard',
+    getClipboard: 'mobileGetClipboard',
   };
 }
 

package/lib/commands/misc.js

@@ -40,22 +40,6 @@ export async function setOrientation(orientation) {
   );
 }
 
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function getClipboard() {
-  return String(
-    (await this.adb.getApiLevel()) < 29
-      ? await this.uiautomator2.jwproxy.command(
-          '/appium/device/get_clipboard',
-          'POST',
-          {}
-        )
-      : await this.settingsApp.getClipboard()
-  );
-}
-
 /**
  * @this {AndroidUiautomator2Driver}
  * @returns {Promise<void>}

package/lib/commands/types.ts

@@ -471,3 +471,18 @@ export interface ActionResult {
 export interface ActionArgs {
   name: string;
 }
+
+export interface SetClipboardOpts {
+  /**
+   * Base64-encoded clipboard payload
+   */
+  content: string;
+  /**
+   * Only a single content type is supported, which is 'plaintext'
+   */
+  contentType?: 'plaintext';
+  /**
+   * Optinal label to identify the current clipboard payload
+   */
+  label?: string;
+}

package/lib/driver.ts

@@ -61,6 +61,12 @@ import {
 import {
   mobileGetBatteryInfo,
 } from './commands/battery';
+import {
+  getClipboard,
+  mobileGetClipboard,
+  setClipboard,
+  mobileSetClipboard,
+} from './commands/clipboard';
 import {
   active,
   getAttribute,
@@ -111,7 +117,6 @@ import {
   getPageSource,
   getOrientation,
   setOrientation,
-  getClipboard,
   openNotifications,
   suspendChromedriverProxy,
   mobileGetDeviceInfo,
@@ -1054,11 +1059,15 @@ class AndroidUiautomator2Driver
   getPageSource = getPageSource;
   getOrientation = getOrientation;
   setOrientation = setOrientation;
-  getClipboard = getClipboard;
   openNotifications = openNotifications;
   suspendChromedriverProxy = suspendChromedriverProxy as any;
   mobileGetDeviceInfo = mobileGetDeviceInfo;
 
+  getClipboard = getClipboard;
+  mobileGetClipboard = mobileGetClipboard;
+  setClipboard = setClipboard;
+  mobileSetClipboard = mobileSetClipboard;
+
   setUrl = setUrl;
   mobileDeepLink = mobileDeepLink;
   back = back;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "3.6.0",
+      "version": "3.7.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^12.2.0",
@@ -35,23 +35,19 @@
         "@semantic-release/changelog": "^6.0.1",
         "@semantic-release/git": "^10.0.1",
         "@types/bluebird": "^3.5.38",
-        "@types/chai": "^4.3.5",
-        "@types/chai-as-promised": "^7.1.5",
         "@types/lodash": "^4.14.194",
         "@types/mocha": "^10.0.1",
         "@types/node": "^20.2.3",
         "@types/portscanner": "^2.1.1",
         "@types/semver": "^7.5.0",
-        "@types/sinon": "^17.0.0",
-        "@types/sinon-chai": "^3.2.9",
         "@types/source-map-support": "^0.x",
         "@types/teen_process": "^2.0.0",
         "@types/ws": "^8.5.4",
         "@xmldom/xmldom": "^0.x",
         "android-apidemos": "^4.1.1",
         "appium": "^2.0.0-rc.3",
-        "chai": "^4.1.2",
-        "chai-as-promised": "^7.1.1",
+        "chai": "^5.1.1",
+        "chai-as-promised": "^8.0.0",
         "conventional-changelog-conventionalcommits": "^8.0.0",
         "fancy-log": "^2.0.0",
         "mocha": "^10.0.0",
@@ -60,7 +56,6 @@
         "semantic-release": "^24.0.0",
         "sharp": "^0.x",
         "sinon": "^18.0.0",
-        "sinon-chai": "^3.7.0",
         "ts-node": "^10.9.1",
         "typescript": "^5.4.2",
         "unzipper": "^0.x",
@@ -806,9 +801,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.14.8",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.8.tgz",
-      "integrity": "sha512-DO+2/jZinXfROG7j7WKFn/3C6nFwxy2lLpgLjEXJz+0XKphZlTLJ14mo8Vfg8X5BWN6XjyESXq+LcYdT7tR3bA==",
+      "version": "20.14.9",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.9.tgz",
+      "integrity": "sha512-06OCtnTXtWOZBJlRApleWndH4JsRVs1pDCc8dLSQp+7PpUpX3ePdHyeNSFTeSe7FtKyQkrlPvHwJOW3SLd8Oyg==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }
@@ -1077,11 +1072,11 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "9.7.0",
-      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.7.0.tgz",
-      "integrity": "sha512-0XWMOuuA8uzMcHturqYwfECnY6imfPzXuPxs75/XfUuyDCkVE7zHoAQaYJes3Q3A6tE9MEMTvmY3GKyjJR6koQ==",
+      "version": "9.7.2",
+      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.7.2.tgz",
+      "integrity": "sha512-AxguUmVx3YqFOMBjIeWqA8mAiRMk9/pJXjlS/SQc8dezS4v8YSvuNP1fjihrndq70HDrQJ6ciW46nGug1i3BWw==",
       "dependencies": {
-        "@appium/support": "^4.2.0",
+        "@appium/support": "^5.0.3",
         "@colors/colors": "^1.6.0",
         "appium-adb": "^12.3.0",
         "appium-chromedriver": "^5.5.1",
@@ -1108,133 +1103,10 @@
         "appium": "^2.0.0"
       }
     },
-    "node_modules/appium-android-driver/node_modules/@appium/schema": {
-      "version": "0.5.0",
-      "resolved": "https://registry.npmjs.org/@appium/schema/-/schema-0.5.0.tgz",
-      "integrity": "sha512-HFed9HtFU6+kLdVyp/xpS/Wfcge8PuMS37LJVShviT6OuzHOYvNFx1/y8+KMa/l0Npvll5eafdfHmUsWlRnUAA==",
-      "dependencies": {
-        "@types/json-schema": "7.0.15",
-        "json-schema": "0.4.0",
-        "source-map-support": "0.5.21"
-      },
-      "engines": {
-        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-        "npm": ">=8"
-      }
-    },
-    "node_modules/appium-android-driver/node_modules/@appium/support": {
-      "version": "4.5.0",
-      "resolved": "https://registry.npmjs.org/@appium/support/-/support-4.5.0.tgz",
-      "integrity": "sha512-9pr8sjnvQud3gBaF/RGj1FdySPjcOuDuKE5w4rfYht/HHlnC3GkfNtQG1FH4rqAIbkOk72HoFr4eaQrQV/cc3g==",
-      "dependencies": {
-        "@appium/logger": "^1.3.0",
-        "@appium/tsconfig": "^0.3.3",
-        "@appium/types": "^0.19.2",
-        "@colors/colors": "1.6.0",
-        "@types/archiver": "6.0.2",
-        "@types/base64-stream": "1.0.5",
-        "@types/find-root": "1.1.4",
-        "@types/jsftp": "2.1.5",
-        "@types/klaw": "3.0.6",
-        "@types/lockfile": "1.0.4",
-        "@types/mv": "2.1.4",
-        "@types/ncp": "2.0.8",
-        "@types/pluralize": "0.0.33",
-        "@types/semver": "7.5.8",
-        "@types/shell-quote": "1.7.5",
-        "@types/supports-color": "8.1.3",
-        "@types/teen_process": "2.0.4",
-        "@types/uuid": "9.0.8",
-        "@types/which": "3.0.4",
-        "archiver": "7.0.1",
-        "axios": "1.7.2",
-        "base64-stream": "1.0.0",
-        "bluebird": "3.7.2",
-        "bplist-creator": "0.1.1",
-        "bplist-parser": "0.3.2",
-        "form-data": "4.0.0",
-        "get-stream": "6.0.1",
-        "glob": "10.4.1",
-        "jsftp": "2.1.3",
-        "klaw": "4.1.0",
-        "lockfile": "1.0.4",
-        "lodash": "4.17.21",
-        "log-symbols": "4.1.0",
-        "moment": "2.30.1",
-        "mv": "2.1.1",
-        "ncp": "2.0.0",
-        "opencv-bindings": "4.5.5",
-        "pkg-dir": "5.0.0",
-        "plist": "3.1.0",
-        "pluralize": "8.0.0",
-        "read-pkg": "5.2.0",
-        "resolve-from": "5.0.0",
-        "sanitize-filename": "1.6.3",
-        "semver": "7.6.2",
-        "shell-quote": "1.8.1",
-        "source-map-support": "0.5.21",
-        "supports-color": "8.1.1",
-        "teen_process": "2.1.4",
-        "type-fest": "4.19.0",
-        "uuid": "9.0.1",
-        "which": "4.0.0",
-        "yauzl": "3.1.3"
-      },
-      "engines": {
-        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-        "npm": ">=8"
-      },
-      "optionalDependencies": {
-        "sharp": "0.33.4"
-      }
-    },
-    "node_modules/appium-android-driver/node_modules/@appium/types": {
-      "version": "0.19.2",
-      "resolved": "https://registry.npmjs.org/@appium/types/-/types-0.19.2.tgz",
-      "integrity": "sha512-u4oHR8TaFK3uyptgOT26/u3zQU5N6vh652OHIpRDJ78EDWgCWXLfIA6YdF8tA8YMrvZHhRpX9om04+9l8wSXyA==",
-      "dependencies": {
-        "@appium/logger": "^1.3.0",
-        "@appium/schema": "^0.5.0",
-        "@appium/tsconfig": "^0.3.3",
-        "@types/express": "4.17.21",
-        "@types/ws": "8.5.10",
-        "type-fest": "4.19.0"
-      },
-      "engines": {
-        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-        "npm": ">=8"
-      }
-    },
-    "node_modules/appium-android-driver/node_modules/teen_process": {
-      "version": "2.1.4",
-      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-2.1.4.tgz",
-      "integrity": "sha512-TEaxCYk/aCBsNBCZmgUNXqtCWq8RX94nGoyYYu7YiNR+RnmawMFshTkYe1SFhiNCX6FsYb6wL/irs6NhvfoF5g==",
-      "dependencies": {
-        "bluebird": "^3.7.2",
-        "lodash": "^4.17.21",
-        "shell-quote": "^1.8.1",
-        "source-map-support": "^0.x"
-      },
-      "engines": {
-        "node": "^16.13.0 || >=18.0.0",
-        "npm": ">=8"
-      }
-    },
-    "node_modules/appium-android-driver/node_modules/type-fest": {
-      "version": "4.19.0",
-      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.19.0.tgz",
-      "integrity": "sha512-CN2l+hWACRiejlnr68vY0/7734Kzu+9+TOslUXbSCQ1ruY9XIHDBSceVXCcHm/oXrdzhtLMMdJEKfemf1yXiZQ==",
-      "engines": {
-        "node": ">=16"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/sindresorhus"
-      }
-    },
     "node_modules/appium-chromedriver": {
-      "version": "5.6.61",
-      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-5.6.61.tgz",
-      "integrity": "sha512-PO2HioadxOE+yijz+YgPbWxAbPJn0H0mW1tTvpWz45x9kTWMgXY5lXAv9jSZsSF2iTx8DOxInUltEBr9dPIjLw==",
+      "version": "5.6.62",
+      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-5.6.62.tgz",
+      "integrity": "sha512-kl5IVK1bRpihAHW2O3DBF0xuWzorraRh1q0/+a/Tlfd6KFCB0mF1HBDW/CnT3g8asZvQaftu3o6nKlKXaYeuHQ==",
       "hasInstallScript": true,
       "dependencies": {
         "@appium/base-driver": "^9.1.0",
@@ -1381,9 +1253,9 @@
       }
     },
     "node_modules/appium-uiautomator2-server": {
-      "version": "7.0.14",
-      "resolved": "https://registry.npmjs.org/appium-uiautomator2-server/-/appium-uiautomator2-server-7.0.14.tgz",
-      "integrity": "sha512-EfR+ifutelJBBeGYMANIhuX9ClXqsaXoQR0fssJotnTay3htvJuMvELUVHrMT5aQnzEG70Xfz2W67cgjcqGFVQ==",
+      "version": "7.0.15",
+      "resolved": "https://registry.npmjs.org/appium-uiautomator2-server/-/appium-uiautomator2-server-7.0.15.tgz",
+      "integrity": "sha512-exTM7AAH7wL9flaLrHmP7zplgUPAMj3dfpfGpa5wWcZbpUVUqKMxxZLi1ZY2stmCIPTGoYWuAF4h2T9f1Qe2DQ==",
       "engines": {
         "node": ">=14",
         "npm": ">=8"
@@ -3184,9 +3056,9 @@
       "optional": true
     },
     "node_modules/minimatch": {
-      "version": "9.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz",
-      "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==",
+      "version": "9.0.5",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz",
+      "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==",
       "dependencies": {
         "brace-expansion": "^2.0.1"
       },

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "3.6.0",
+  "version": "3.7.0",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -82,23 +82,19 @@
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
     "@types/bluebird": "^3.5.38",
-    "@types/chai": "^4.3.5",
-    "@types/chai-as-promised": "^7.1.5",
     "@types/lodash": "^4.14.194",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.2.3",
     "@types/portscanner": "^2.1.1",
     "@types/semver": "^7.5.0",
-    "@types/sinon": "^17.0.0",
-    "@types/sinon-chai": "^3.2.9",
     "@types/source-map-support": "^0.x",
     "@types/teen_process": "^2.0.0",
     "@types/ws": "^8.5.4",
     "@xmldom/xmldom": "^0.x",
     "android-apidemos": "^4.1.1",
     "appium": "^2.0.0-rc.3",
-    "chai": "^4.1.2",
-    "chai-as-promised": "^7.1.1",
+    "chai": "^5.1.1",
+    "chai-as-promised": "^8.0.0",
     "conventional-changelog-conventionalcommits": "^8.0.0",
     "fancy-log": "^2.0.0",
     "mocha": "^10.0.0",
@@ -107,7 +103,6 @@
     "semantic-release": "^24.0.0",
     "sharp": "^0.x",
     "sinon": "^18.0.0",
-    "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.4.2",
     "unzipper": "^0.x",