@appium/mcp-documentation 1.0.2 → 1.0.4

package/src/resources/submodules/appium/packages/support/README.md

@@ -0,0 +1,161 @@
+# @appium/support
+
+> Utility functions used to support Appium drivers and plugins
+
+[![NPM version](http://img.shields.io/npm/v/@appium/support.svg)](https://npmjs.org/package/@appium/support)
+[![Downloads](http://img.shields.io/npm/dm/@appium/support.svg)](https://npmjs.org/package/@appium/support)
+
+## Usage in drivers and plugins
+
+Drivers and plugins are recommended to have Appium as a peer dependency, as it already includes
+these utility functions. Add the following line to `peerDependencies` section of your module's
+`package.json`:
+
+```js
+  "peerDependencies": {
+    "appium": "^<minimum_server_version>"
+  }
+```
+
+Afterwards import it in your code similarly to the below example:
+
+```js
+import {timing, util} from 'appium/support';
+```
+
+## Usage in helper modules
+
+If you want to use this module in a helper library, which is not a driver or a plugin,
+then add the following line to `dependencies` section of your module's `package.json`:
+
+```js
+  "dependencies": {
+    "@appium/support": "<module_version>"
+  }
+```
+
+Afterwards import it in your code similarly to the below example:
+
+```js
+import {timing, util} from '@appium/support';
+```
+
+## Categories
+
+All utility functions are split into a bunch of different categories. Each category has its own file under the `lib` folder. All utility functions in these files are documented.
+
+|Category|Description|
+|-|-|
+|console|Wrappers for the command line interface abstraction used by the Appium server|
+|doctor|Common doctor utilities that can be used by drivers and plugins|
+|env|Several helpers needed by the server to cope with internal dependencies and manifests|
+|fs|Most of the functions here are just thin wrappers over utility functions available in [Promises API](https://nodejs.org/api/fs.html#promises-api)|
+|image-util|Utilities to work with images. Use [sharp](https://github.com/lovell/sharp) under the hood.<br>:bangbang: Node >=18.17 is required to use these utilities|
+|logging|See [the logging section below](#logging)|
+|mjpeg|Helpers needed to implement [MJPEG streaming](https://en.wikipedia.org/wiki/Motion_JPEG#Video_streaming)|
+|net|Helpers needed for network interactions, for example, upload and download of files|
+|node|Set of Node.js-specific utility functions needed, for example, to ensure objects immutability or to calculate their sizes|
+|npm|Set of `npm`-related helpers|
+|plist|Set of utilities used to read and write data from [plist](https://en.wikipedia.org/wiki/Property_List) files in javascript|
+|process|Helpers for interactions with system processes. These APIs don't support Windows.|
+|system|Set of helper functions needed to determine properties of the current operating system|
+|tempdir|Set of helpers that allow interactions with temporary folders|
+|timing|Helpers that allow to measure execution time|
+|util|Miscellaneous utilities|
+|zip|Helpers that allow to work with archives in `.zip ` format|
+
+## logging
+
+This is a basic logger defaulting to [npmlog](https://github.com/npm/npmlog) with special
+consideration for running tests (doesn't output logs when run with `_TESTING=1`).
+
+### Logging levels
+
+There are a number of levels, exposed as methods on the log object, at which logging can be made.
+The built-in ones correspond to those of [npmlog](https://github.com/npm/npmlog#loglevelprefix-message-),
+and are: `silly`, `verbose`, `info`, `http`, `warn`, and `error`. There is also a `debug` level.
+
+The default threshold level is `verbose`.
+
+The logged output, by default, will be `level prefix message`. So
+
+```js
+import {logging} from 'appium/support';
+let log = logging.getLogger('mymodule');
+log.warn('a warning');`
+```
+
+Will produce
+
+```shell
+warn mymodule a warning
+```
+
+### Environment variables
+
+There are two environment variable flags that affect the way `logger` works.
+
+|Variable|Description|
+|-|-|
+|`_TESTING`|If set to `1`, logging output is stopped|
+|`_FORCE_LOGS`|If set to `1`, overrides the value of `_TESTING`|
+
+### Usage
+
+`log.level`
+
+- Get and set the threshold level at which to display the logs. Any logs at or above this level will
+be displayed. The special level `silent` will prevent anything from being displayed ever. See
+[npmlog#level](https://github.com/npm/npmlog#loglevel) for more details.
+
+`log[level](message)`
+
+- Logs `message` at the specified `level`
+```js
+import {logging} from 'appium/support';
+let log = logging.getLogger('mymodule');
+
+log.info('hi!');
+// => info mymodule hi!
+```
+
+`log.unwrap()`
+
+- Retrieves the underlying [npmlog](https://github.com/npm/npmlog) object, in order to manage how
+logging is done at a low level (e.g., changing output streams, retrieving an array of messages,
+adding log levels, etc.).
+
+```js
+import {logging} from 'appium/support';
+let log = logging.getLogger('mymodule');
+
+log.info('hi!');
+
+let npmlogger = log.unwrap();
+
+// any `npmlog` methods
+let logs = npmlogger.record;
+// logs === [ { id: 0, level: 'info', prefix: 'mymodule', message: 'hi!', messageRaw: [ 'hi!' ] }]
+```
+
+`log.errorWithException(error)`
+
+- Logs the error passed in, at `error` level, and then returns the error. If the error passed in is
+not an instance of [Error](https://nodejs.org/api/errors.html#errors_class_error) (either directly,
+or a subclass of `Error`), it will be wrapped in a generic `Error` object.
+
+```js
+import {logging} from 'appium/support';
+let log = logging.getLogger('mymodule');
+
+// previously there would be two lines
+log.error('This is an error');
+throw new Error('This is an error');
+
+// now is compacted
+throw log.errorWithException('This is an error');
+```
+
+## License
+
+Apache-2.0

package/src/resources/submodules/appium/packages/tsconfig/CHANGELOG.md

@@ -0,0 +1,147 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.2](https://github.com/appium/appium/compare/@appium/tsconfig@1.1.1...@appium/tsconfig@1.1.2) (2026-03-08)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [1.1.1](https://github.com/appium/appium/compare/@appium/tsconfig@1.1.0...@appium/tsconfig@1.1.1) (2025-12-04)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [1.1.0](https://github.com/appium/appium/compare/@appium/tsconfig@1.0.0...@appium/tsconfig@1.1.0) (2025-09-09)
+
+
+### Features
+
+* **tsconfig:** update base to Node20 ([#21505](https://github.com/appium/appium/issues/21505)) ([2d1af2b](https://github.com/appium/appium/commit/2d1af2bd67b2fdf5df1d2f8fa795270cc5ec06a7))
+
+
+
+## [1.0.0](https://github.com/appium/appium/compare/@appium/tsconfig@1.0.0-rc.1...@appium/tsconfig@1.0.0) (2025-08-18)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [1.0.0-rc.1](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.4...@appium/tsconfig@1.0.0-rc.1) (2025-08-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* set minimum Node.js version to v20.19.0 (#21394)
+
+### Miscellaneous Chores
+
+* set minimum Node.js version to v20.19.0 ([#21394](https://github.com/appium/appium/issues/21394)) ([37e22c4](https://github.com/appium/appium/commit/37e22c4f9c9920cea3f340841ab1b7c60e3147e9))
+
+
+
+## [0.3.5](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.4...@appium/tsconfig@0.3.5) (2025-03-11)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [0.3.4](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.3...@appium/tsconfig@0.3.4) (2025-02-20)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [0.3.3](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.2...@appium/tsconfig@0.3.3) (2024-04-08)
+
+
+### Bug Fixes
+
+* **tsconfig:** update dependency @tsconfig/node14 to v14.1.1 ([de057fa](https://github.com/appium/appium/commit/de057fa8b043a26f4854c930df5a560d89808ca6))
+* **tsconfig:** update dependency @tsconfig/node14 to v14.1.2 ([66626d2](https://github.com/appium/appium/commit/66626d26e52b6241b5618dc1052c86d48230d15e))
+
+
+
+## [0.3.2](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.1...@appium/tsconfig@0.3.2) (2023-10-18)
+
+
+### Bug Fixes
+
+* **tsconfig:** update dependency @tsconfig/node14 to v14 ([#19082](https://github.com/appium/appium/issues/19082)) ([65b3787](https://github.com/appium/appium/commit/65b3787912a4948fb1ed48e8095299bc9ba95844))
+
+
+
+## [0.3.1](https://github.com/appium/appium/compare/@appium/tsconfig@0.3.0...@appium/tsconfig@0.3.1) (2023-08-22)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v8 ([#18095](https://github.com/appium/appium/issues/18095)) ([b608db9](https://github.com/appium/appium/commit/b608db91a8ef0e3cad43ce3e14b625bf9234d383))
+
+
+
+# [0.3.0](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.4...@appium/tsconfig@0.3.0) (2023-04-10)
+
+
+### Features
+
+* **strongbox:** create @appium/strongbox ([fd91234](https://github.com/appium/appium/commit/fd912346fade8f29f5b4d1458828ea677d7e9fcc))
+
+
+
+
+
+## [0.2.4](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.3...@appium/tsconfig@0.2.4) (2023-02-09)
+
+
+### Bug Fixes
+
+* **tsconfig:** remove test-related types from shared tsconfig ([94940b2](https://github.com/appium/appium/commit/94940b274f27153851e97973d94c240f0089c0ea))
+
+
+
+
+
+## [0.2.3](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.2...@appium/tsconfig@0.2.3) (2023-01-13)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [0.2.2](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.1...@appium/tsconfig@0.2.2) (2023-01-13)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+## [0.2.1](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.0...@appium/tsconfig@0.2.1) (2023-01-13)
+
+**Note:** Version bump only for package @appium/tsconfig
+
+
+
+
+
+# 0.2.0 (2023-01-13)
+
+
+### Features
+
+* create @appium/tsconfig ([7d7b510](https://github.com/appium/appium/commit/7d7b510a03afb1f103be783e7696e7faec0b296a))

package/src/resources/submodules/appium/packages/tsconfig/README.md

@@ -0,0 +1,19 @@
+# @appium/tsconfig
+
+> Shared TypeScript Config for Appium
+
+## Motivation
+
+Appium projects and extensions are encouraged to use these settings.
+
+## Install
+
+```bash
+npm install appium @appium/tsconfig -D
+```
+
+[appium](https://npm.im/appium) is a peer dependency of this package.
+
+## License
+
+Apache-2.0