io.appium.settings 6.0.5 → 6.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ ## [6.0.7](https://github.com/appium/io.appium.settings/compare/v6.0.6...v6.0.7) (2025-10-17)
2
+
3
+ ### Miscellaneous Chores
4
+
5
+ * **deps-dev:** bump semantic-release from 24.2.9 to 25.0.0 ([#239](https://github.com/appium/io.appium.settings/issues/239)) ([231c11d](https://github.com/appium/io.appium.settings/commit/231c11d59baec72df49ccce76c5aeeb292361c81))
6
+
7
+ ## [6.0.6](https://github.com/appium/io.appium.settings/compare/v6.0.5...v6.0.6) (2025-09-27)
8
+
9
+ ### Miscellaneous Chores
10
+
11
+ * fix typos ([#238](https://github.com/appium/io.appium.settings/issues/238)) ([87d64b3](https://github.com/appium/io.appium.settings/commit/87d64b3a164ca1d64b482e744e9985cbd49cbeed))
12
+
1
13
  ## [6.0.5](https://github.com/appium/io.appium.settings/compare/v6.0.4...v6.0.5) (2025-09-25)
2
14
 
3
15
  ### Miscellaneous Chores
package/README.md CHANGED
@@ -64,7 +64,7 @@ import { SettingsApp } from 'io.appium.settings';
64
64
 
65
65
  async function main() {
66
66
  // It is expected 'io.appium.settings' is already installed on the device
67
- // and the neccessary permissions are granted to it.
67
+ // and the necessary permissions are granted to it.
68
68
  // Check https://github.com/appium/appium-android-driver/blob/master/lib/helpers/android.ts
69
69
  // if you are looking on how to automate this process.
70
70
  const app = new SettingsApp({
Binary file
@@ -48,7 +48,7 @@ export class SettingsApp {
48
48
  /**
49
49
  * If the io.appium.settings package has running foreground service.
50
50
  * It returns the io.appium.settings's process existence for api level 25 and lower
51
- * becase the concept of foreground services has only been introduced since API 26
51
+ * because the concept of foreground services has only been introduced since API 26
52
52
  *
53
53
  * @throws {Error} If the method gets an error in the adb shell execution.
54
54
  * @returns {Promise<boolean>} Return true if the device Settings app has a servicve running in foreground.
@@ -57,7 +57,7 @@ export class SettingsApp {
57
57
  /**
58
58
  * Performs broadcast and verifies the result of it
59
59
  *
60
- * @param {string[]} args Arguments passed to the `am broadcast` comand
60
+ * @param {string[]} args Arguments passed to the `am broadcast` command
61
61
  * @param {string} action The exception message in case of broadcast failure
62
62
  * @param {boolean} [requireRunningApp=true] Whether to run a check for a running Appium Settings app
63
63
  * @returns {Promise<string>}
@@ -100,7 +100,7 @@ class SettingsApp {
100
100
  /**
101
101
  * If the io.appium.settings package has running foreground service.
102
102
  * It returns the io.appium.settings's process existence for api level 25 and lower
103
- * becase the concept of foreground services has only been introduced since API 26
103
+ * because the concept of foreground services has only been introduced since API 26
104
104
  *
105
105
  * @throws {Error} If the method gets an error in the adb shell execution.
106
106
  * @returns {Promise<boolean>} Return true if the device Settings app has a servicve running in foreground.
@@ -118,7 +118,7 @@ class SettingsApp {
118
118
  /**
119
119
  * Performs broadcast and verifies the result of it
120
120
  *
121
- * @param {string[]} args Arguments passed to the `am broadcast` comand
121
+ * @param {string[]} args Arguments passed to the `am broadcast` command
122
122
  * @param {string} action The exception message in case of broadcast failure
123
123
  * @param {boolean} [requireRunningApp=true] Whether to run a check for a running Appium Settings app
124
124
  * @returns {Promise<string>}
@@ -6,7 +6,7 @@
6
6
  */
7
7
  export function setBluetoothState(this: import("../client").SettingsApp, on: boolean): Promise<void>;
8
8
  /**
9
- * Unpairs all previosly paired bluetooth devices if any exist
9
+ * Unpairs all previously paired bluetooth devices if any exist
10
10
  *
11
11
  * @this {import('../client').SettingsApp}
12
12
  */
@@ -22,7 +22,7 @@ async function setBluetoothState(on) {
22
22
  }
23
23
  }
24
24
  /**
25
- * Unpairs all previosly paired bluetooth devices if any exist
25
+ * Unpairs all previously paired bluetooth devices if any exist
26
26
  *
27
27
  * @this {import('../client').SettingsApp}
28
28
  */
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Retrieves the text content of the device's clipboard.
3
3
  * The method works for Android below and above 29.
4
- * It temorarily enforces the IME setting in order to workaround
4
+ * It temporarily enforces the IME setting in order to workaround
5
5
  * security limitations if needed.
6
6
  * This method only works if Appium Settings v. 2.15+ is installed
7
7
  * on the device under test
@@ -10,7 +10,7 @@
10
10
  * @returns {Promise<string>} The actual content of the main clipboard as
11
11
  * base64-encoded string or an empty string if the clipboard is empty
12
12
  * @throws {Error} If there was a problem while getting the
13
- * clipboard contant
13
+ * clipboard content
14
14
  */
15
15
  export function getClipboard(this: import("../client").SettingsApp): Promise<string>;
16
16
  //# sourceMappingURL=clipboard.d.ts.map
@@ -10,7 +10,7 @@ const constants_1 = require("../constants");
10
10
  /**
11
11
  * Retrieves the text content of the device's clipboard.
12
12
  * The method works for Android below and above 29.
13
- * It temorarily enforces the IME setting in order to workaround
13
+ * It temporarily enforces the IME setting in order to workaround
14
14
  * security limitations if needed.
15
15
  * This method only works if Appium Settings v. 2.15+ is installed
16
16
  * on the device under test
@@ -19,7 +19,7 @@ const constants_1 = require("../constants");
19
19
  * @returns {Promise<string>} The actual content of the main clipboard as
20
20
  * base64-encoded string or an empty string if the clipboard is empty
21
21
  * @throws {Error} If there was a problem while getting the
22
- * clipboard contant
22
+ * clipboard content
23
23
  */
24
24
  async function getClipboard() {
25
25
  this.log.debug(logger_1.LOG_PREFIX, 'Getting the clipboard content');
@@ -41,7 +41,7 @@ async function getClipboard() {
41
41
  }
42
42
  const match = /data="([^"]*)"/.exec(output);
43
43
  if (!match) {
44
- throw new Error(`Cannot parse the actual cliboard content from the command output: ${output}`);
44
+ throw new Error(`Cannot parse the actual clipboard content from the command output: ${output}`);
45
45
  }
46
46
  return lodash_1.default.trim(match[1]);
47
47
  }
@@ -1 +1 @@
1
- {"version":3,"file":"clipboard.js","sourceRoot":"","sources":["../../../lib/commands/clipboard.js"],"names":[],"mappings":";;;;;AAsBA,oCAuBC;AA7CD,oDAAuB;AACvB,sCAAuC;AACvC,4CAIsB;AAEtB;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,YAAY;IAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,+BAA+B,CAAC,CAAC;IAC5D,MAAM,IAAI,CAAC,cAAc,CAAC,EAAC,uBAAuB,EAAE,IAAI,EAAC,CAAC,CAAC;IAC3D,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC;QAC9D,IAAI,EAAE,8BAAkB;QACxB,IAAI,EAAE,sCAA0B;KACjC,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;YAC3C,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,sBAAU,EAAE,iBAAiB,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iEAAiE;YAC/E,2DAA2D;YAC3D,mBAAmB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,qEAAqE,MAAM,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,OAAO,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC"}
1
+ {"version":3,"file":"clipboard.js","sourceRoot":"","sources":["../../../lib/commands/clipboard.js"],"names":[],"mappings":";;;;;AAsBA,oCAuBC;AA7CD,oDAAuB;AACvB,sCAAuC;AACvC,4CAIsB;AAEtB;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,YAAY;IAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAU,EAAE,+BAA+B,CAAC,CAAC;IAC5D,MAAM,IAAI,CAAC,cAAc,CAAC,EAAC,uBAAuB,EAAE,IAAI,EAAC,CAAC,CAAC;IAC3D,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC;QAC9D,IAAI,EAAE,8BAAkB;QACxB,IAAI,EAAE,sCAA0B;KACjC,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;YAC3C,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,sBAAU,EAAE,iBAAiB,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iEAAiE;YAC/E,2DAA2D;YAC3D,mBAAmB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,sEAAsE,MAAM,EAAE,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC"}
@@ -11,7 +11,7 @@ export function makeMediaProjectionRecorder(this: import("../client").SettingsAp
11
11
  * Media Projection-based recording service
12
12
  *
13
13
  * @this {import('../client').SettingsApp}
14
- * @returns {Promise<boolean>} If the permssions adjustment has actually been made
14
+ * @returns {Promise<boolean>} If the permissions adjustment has actually been made
15
15
  */
16
16
  export function adjustMediaProjectionServicePermissions(this: import("../client").SettingsApp): Promise<boolean>;
17
17
  export type StartMediaProjectionRecordingOpts = {
@@ -149,7 +149,7 @@ function makeMediaProjectionRecorder() {
149
149
  * Media Projection-based recording service
150
150
  *
151
151
  * @this {import('../client').SettingsApp}
152
- * @returns {Promise<boolean>} If the permssions adjustment has actually been made
152
+ * @returns {Promise<boolean>} If the permissions adjustment has actually been made
153
153
  */
154
154
  async function adjustMediaProjectionServicePermissions() {
155
155
  if (await this.adb.getApiLevel() >= 29) {
@@ -49,7 +49,7 @@
49
49
  export function getNotifications(this: import("../client").SettingsApp): Promise<Record<string, any>>;
50
50
  /**
51
51
  * Adjusts the necessary permissions for the
52
- * Notifications retreval service for Android API level 29+
52
+ * Notifications retrieval service for Android API level 29+
53
53
  *
54
54
  * @this {import('../client').SettingsApp}
55
55
  * @returns {Promise<boolean>} If permissions adjustment has been actually made
@@ -62,7 +62,7 @@ async function getNotifications() {
62
62
  ;
63
63
  /**
64
64
  * Adjusts the necessary permissions for the
65
- * Notifications retreval service for Android API level 29+
65
+ * Notifications retrieval service for Android API level 29+
66
66
  *
67
67
  * @this {import('../client').SettingsApp}
68
68
  * @returns {Promise<boolean>} If permissions adjustment has been actually made
package/lib/client.js CHANGED
@@ -107,7 +107,7 @@ export class SettingsApp {
107
107
  /**
108
108
  * If the io.appium.settings package has running foreground service.
109
109
  * It returns the io.appium.settings's process existence for api level 25 and lower
110
- * becase the concept of foreground services has only been introduced since API 26
110
+ * because the concept of foreground services has only been introduced since API 26
111
111
  *
112
112
  * @throws {Error} If the method gets an error in the adb shell execution.
113
113
  * @returns {Promise<boolean>} Return true if the device Settings app has a servicve running in foreground.
@@ -127,7 +127,7 @@ export class SettingsApp {
127
127
  /**
128
128
  * Performs broadcast and verifies the result of it
129
129
  *
130
- * @param {string[]} args Arguments passed to the `am broadcast` comand
130
+ * @param {string[]} args Arguments passed to the `am broadcast` command
131
131
  * @param {string} action The exception message in case of broadcast failure
132
132
  * @param {boolean} [requireRunningApp=true] Whether to run a check for a running Appium Settings app
133
133
  * @returns {Promise<string>}
@@ -24,7 +24,7 @@ export async function setBluetoothState (on) {
24
24
  }
25
25
 
26
26
  /**
27
- * Unpairs all previosly paired bluetooth devices if any exist
27
+ * Unpairs all previously paired bluetooth devices if any exist
28
28
  *
29
29
  * @this {import('../client').SettingsApp}
30
30
  */
@@ -9,7 +9,7 @@ import {
9
9
  /**
10
10
  * Retrieves the text content of the device's clipboard.
11
11
  * The method works for Android below and above 29.
12
- * It temorarily enforces the IME setting in order to workaround
12
+ * It temporarily enforces the IME setting in order to workaround
13
13
  * security limitations if needed.
14
14
  * This method only works if Appium Settings v. 2.15+ is installed
15
15
  * on the device under test
@@ -18,7 +18,7 @@ import {
18
18
  * @returns {Promise<string>} The actual content of the main clipboard as
19
19
  * base64-encoded string or an empty string if the clipboard is empty
20
20
  * @throws {Error} If there was a problem while getting the
21
- * clipboard contant
21
+ * clipboard content
22
22
  */
23
23
  export async function getClipboard () {
24
24
  this.log.debug(LOG_PREFIX, 'Getting the clipboard content');
@@ -40,7 +40,7 @@ export async function getClipboard () {
40
40
 
41
41
  const match = /data="([^"]*)"/.exec(output);
42
42
  if (!match) {
43
- throw new Error(`Cannot parse the actual cliboard content from the command output: ${output}`);
43
+ throw new Error(`Cannot parse the actual clipboard content from the command output: ${output}`);
44
44
  }
45
45
  return _.trim(match[1]);
46
46
  }
@@ -166,7 +166,7 @@ export function makeMediaProjectionRecorder() {
166
166
  * Media Projection-based recording service
167
167
  *
168
168
  * @this {import('../client').SettingsApp}
169
- * @returns {Promise<boolean>} If the permssions adjustment has actually been made
169
+ * @returns {Promise<boolean>} If the permissions adjustment has actually been made
170
170
  */
171
171
  export async function adjustMediaProjectionServicePermissions() {
172
172
  if (await this.adb.getApiLevel() >= 29) {
@@ -62,7 +62,7 @@ export async function getNotifications () {
62
62
 
63
63
  /**
64
64
  * Adjusts the necessary permissions for the
65
- * Notifications retreval service for Android API level 29+
65
+ * Notifications retrieval service for Android API level 29+
66
66
  *
67
67
  * @this {import('../client').SettingsApp}
68
68
  * @returns {Promise<boolean>} If permissions adjustment has been actually made
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "io.appium.settings",
3
- "version": "6.0.5",
3
+ "version": "6.0.7",
4
4
  "description": "App for dealing with Android settings",
5
5
  "main": "./build/lib/index.js",
6
6
  "types": "./build/lib/index.d.ts",
@@ -69,7 +69,7 @@
69
69
  "conventional-changelog-conventionalcommits": "^9.0.0",
70
70
  "mocha": "^11.0.1",
71
71
  "prettier": "^3.0.0",
72
- "semantic-release": "^24.0.0",
72
+ "semantic-release": "^25.0.0",
73
73
  "ts-node": "^10.9.1",
74
74
  "typescript": "^5.1.6"
75
75
  }