io.appium.settings 5.7.1 → 5.7.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.7.2](https://github.com/appium/io.appium.settings/compare/v5.7.1...v5.7.2) (2024-01-13)
+
+
+### Miscellaneous Chores
+
+* Bump appium-adb ([#142](https://github.com/appium/io.appium.settings/issues/142)) ([adb209e](https://github.com/appium/io.appium.settings/commit/adb209e3d25a4f996fa52d92894f08d1dda35a9b))
+
 ## [5.7.1](https://github.com/appium/io.appium.settings/compare/v5.7.0...v5.7.1) (2024-01-11)
 
 

package/README.md

@@ -45,6 +45,41 @@ To uninstall:
 $ adb uninstall io.appium.settings
 ```
 
+## Using the JavaScript wrapper
+
+This module exports the [SettingsApp](./lib/client.js) class, which allows you to automate the below interactions with JavaScript.
+The wrapper expects you to also have the [appium-adb](https://github.com/appium/appium-adb) module listed
+in your dependencies. The actual version of the appium-adb module must satisfy the same semver requirement this module
+has in its [devDependencies](./package.json).
+Here is the usage example:
+
+```js
+import ADB from 'appium-adb'
+import { SettingsApp } from 'io.appium.settings';
+
+async function main() {
+  // It is expected 'io.appium.settings' is already installed on the device
+  // and the neccessary permissions are granted to it.
+  // Check https://github.com/appium/appium-android-driver/blob/master/lib/helpers/android.ts
+  // if you are looking on how to automate this process.
+  const app = new SettingsApp({
+    adb: await ADB.createADB()
+  });
+  const recorder = app.makeMediaProjectionRecorder();
+  const filename = 'video.mp4';
+  const didStart = await recorder.start({filename});
+  if (didStart) {
+    log.info(`A new media projection recording '${filename}' has been successfully started`);
+  } else {
+    log.info('A new media projection recording was unable to start. Is it already running?');
+  }
+}
+
+main();
+```
+
+The module also exports various constants containing its service and action names, that could be useful in your
+scripts. Check [constants.js](./lib/constants.js) for more details.
 
 ## Changing of system settings
 
@@ -113,7 +148,7 @@ $ adb shell am broadcast -a io.appium.settings.locale -n io.appium.settings/.rec
 $ adb shell getprop persist.sys.locale # ja-JP
 $ adb shell am broadcast -a io.appium.settings.locale -n io.appium.settings/.receivers.LocaleSettingReceiver --es lang zh --es country CN --es script Hans
 $ adb shell getprop persist.sys.locale # zh-Hans-CN for API level 21+
-# When 'skip_locale_check' parameter is set appium settings application doesn't check that locale you are trying to set is a valid locale string, by default it validates the locale and throws error when invalid 
+# When 'skip_locale_check' parameter is set appium settings application doesn't check that locale you are trying to set is a valid locale string, by default it validates the locale and throws error when invalid
 $ adb shell am broadcast -a io.appium.settings.locale -n io.appium.settings/.receivers.LocaleSettingReceiver --es lang xx --es country US --es skip_locale_check 1
 ```
 
@@ -145,7 +180,7 @@ option would have no effect.
 
 ## Setting Mock Locations
 
-Please set the Appium Settings from the Settings app's _Developer Options_ -> _Select mock location app_. 
+Please set the Appium Settings from the Settings app's _Developer Options_ -> _Select mock location app_.
 Or `adb shell appops set io.appium.settings android:mock_location allow` let you do the same via adb command.
 `adb shell appops set io.appium.settings android:mock_location deny` is to turn it off.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "io.appium.settings",
-  "version": "5.7.1",
+  "version": "5.7.2",
   "description": "App for dealing with Android settings",
   "main": "./build/lib/index.js",
   "types": "./build/lib/index.d.ts",
@@ -68,7 +68,7 @@
     "@types/teen_process": "^2.0.2",
     "@typescript-eslint/eslint-plugin": "^6.9.0",
     "@typescript-eslint/parser": "^6.9.0",
-    "appium-adb": "^11.0.0",
+    "appium-adb": "^12.0.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "conventional-changelog-conventionalcommits": "^7.0.1",