io.appium.settings 5.9.2 → 5.10.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.10.0](https://github.com/appium/io.appium.settings/compare/v5.9.2...v5.10.0) (2024-05-27)
+
+
+### Features
+
+* use adb settings method to set animation for newer than api level 26 ([#176](https://github.com/appium/io.appium.settings/issues/176)) ([d0e5d4f](https://github.com/appium/io.appium.settings/commit/d0e5d4f3b7441d98402828a65717b2fddc6fa3e9))
+
 ## [5.9.2](https://github.com/appium/io.appium.settings/compare/v5.9.1...v5.9.2) (2024-05-18)
 
 

package/README.md

@@ -133,12 +133,16 @@ To turn on `animation`:
 $ adb shell am broadcast -a io.appium.settings.animation --es setstatus enable
 ```
 
+(Note that [Restrictions on non-SDK interfaces](https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces) affects this animation command.)
+
 To turn off `animation`:
 
 ```shell
 $ adb shell am broadcast -a io.appium.settings.animation --es setstatus disable
 ```
 
+(Note that [Restrictions on non-SDK interfaces](https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces) affects this animation command.)
+
 Set particular locale:
 
 ```shell

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

@@ -1,5 +1,5 @@
 /**
- * Change the state of animation on the device under test.
+ * Change the state of animation on the device under test via adb settings command (for API level 26+) or settings app (for API level 25 and lower).
  * Animation on the device is controlled by the following global properties:
  * [ANIMATOR_DURATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#ANIMATOR_DURATION_SCALE},
  * [TRANSITION_ANIMATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#TRANSITION_ANIMATION_SCALE},

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

@@ -1 +1 @@
-{"version":3,"file":"animation.d.ts","sourceRoot":"","sources":["../../../lib/commands/animation.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,6EAFW,OAAO,iBAQjB"}
+{"version":3,"file":"animation.d.ts","sourceRoot":"","sources":["../../../lib/commands/animation.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,6EAFW,OAAO,iBAejB"}

package/build/lib/commands/animation.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setAnimationState = void 0;
 const constants_js_1 = require("../constants.js");
 /**
- * Change the state of animation on the device under test.
+ * Change the state of animation on the device under test via adb settings command (for API level 26+) or settings app (for API level 25 and lower).
  * Animation on the device is controlled by the following global properties:
  * [ANIMATOR_DURATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#ANIMATOR_DURATION_SCALE},
  * [TRANSITION_ANIMATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#TRANSITION_ANIMATION_SCALE},
@@ -17,11 +17,19 @@ const constants_js_1 = require("../constants.js");
  * @param {boolean} on - True to enable and false to disable it.
  */
 async function setAnimationState(on) {
+    if (await this.adb.getApiLevel() >= 26) {
+        await this.adb.setAnimationScale(Number(on));
+        return;
+    }
+    ;
+    // TODO: Please delete AnimationSettingHandler.java implementation also to avoid non-sdk https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces
+    // error in settings app for Android 9 and over when we drop api level 25 and lower.
+    const statusToSet = on ? 'enable' : 'disable';
     await this.checkBroadcast([
         '-a', constants_js_1.ANIMATION_SETTING_ACTION,
         '-n', constants_js_1.ANIMATION_SETTING_RECEIVER,
-        '--es', 'setstatus', on ? 'enable' : 'disable'
-    ], `${on ? 'enable' : 'disable'} animation`);
+        '--es', 'setstatus', statusToSet
+    ], `${statusToSet} animation`);
 }
 exports.setAnimationState = setAnimationState;
 //# sourceMappingURL=animation.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"animation.js","sourceRoot":"","sources":["../../../lib/commands/animation.js"],"names":[],"mappings":";;;AAAA,kDAAuF;AAEvF;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB,CAAE,EAAE;IACzC,MAAM,IAAI,CAAC,cAAc,CAAC;QACxB,IAAI,EAAE,uCAAwB;QAC9B,IAAI,EAAE,yCAA0B;QAChC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;KAC/C,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC;AAC/C,CAAC;AAND,8CAMC"}
+{"version":3,"file":"animation.js","sourceRoot":"","sources":["../../../lib/commands/animation.js"],"names":[],"mappings":";;;AAAA,kDAAuF;AAEvF;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB,CAAE,EAAE;IACzC,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,OAAO;IACT,CAAC;IAAA,CAAC;IACF,8KAA8K;IAC9K,oFAAoF;IACpF,MAAM,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9C,MAAM,IAAI,CAAC,cAAc,CAAC;QACxB,IAAI,EAAE,uCAAwB;QAC9B,IAAI,EAAE,yCAA0B;QAChC,MAAM,EAAE,WAAW,EAAE,WAAW;KACjC,EAAE,GAAG,WAAW,YAAY,CAAC,CAAC;AACjC,CAAC;AAbD,8CAaC"}

package/lib/commands/animation.js

@@ -1,7 +1,7 @@
 import { ANIMATION_SETTING_ACTION, ANIMATION_SETTING_RECEIVER } from '../constants.js';
 
 /**
- * Change the state of animation on the device under test.
+ * Change the state of animation on the device under test via adb settings command (for API level 26+) or settings app (for API level 25 and lower).
  * Animation on the device is controlled by the following global properties:
  * [ANIMATOR_DURATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#ANIMATOR_DURATION_SCALE},
  * [TRANSITION_ANIMATION_SCALE]{@link https://developer.android.com/reference/android/provider/Settings.Global.html#TRANSITION_ANIMATION_SCALE},
@@ -15,9 +15,16 @@ import { ANIMATION_SETTING_ACTION, ANIMATION_SETTING_RECEIVER } from '../constan
  * @param {boolean} on - True to enable and false to disable it.
  */
 export async function setAnimationState (on) {
+  if (await this.adb.getApiLevel() >= 26) {
+    await this.adb.setAnimationScale(Number(on));
+    return;
+  };
+  // TODO: Please delete AnimationSettingHandler.java implementation also to avoid non-sdk https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces
+  // error in settings app for Android 9 and over when we drop api level 25 and lower.
+  const statusToSet = on ? 'enable' : 'disable';
   await this.checkBroadcast([
     '-a', ANIMATION_SETTING_ACTION,
     '-n', ANIMATION_SETTING_RECEIVER,
-    '--es', 'setstatus', on ? 'enable' : 'disable'
-  ], `${on ? 'enable' : 'disable'} animation`);
+    '--es', 'setstatus', statusToSet
+  ], `${statusToSet} animation`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "io.appium.settings",
-  "version": "5.9.2",
+  "version": "5.10.0",
   "description": "App for dealing with Android settings",
   "main": "./build/lib/index.js",
   "types": "./build/lib/index.d.ts",
@@ -66,7 +66,7 @@
     "@types/lodash": "^4.14.196",
     "@types/node": "^20.4.7",
     "@types/teen_process": "^2.0.2",
-    "appium-adb": "^12.0.0",
+    "appium-adb": "^12.4.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "conventional-changelog-conventionalcommits": "^7.0.1",