@appium/mcp-documentation 1.0.3 → 1.0.5

package/src/resources/submodules/appium/packages/storage-plugin/CHANGELOG.md

@@ -0,0 +1,157 @@
+# 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.5](https://github.com/appium/appium/compare/@appium/storage-plugin@1.1.4...@appium/storage-plugin@1.1.5) (2026-05-31)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.1.4](https://github.com/appium/appium/compare/@appium/storage-plugin@1.1.3...@appium/storage-plugin@1.1.4) (2026-05-07)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.1.3](https://github.com/appium/appium/compare/@appium/storage-plugin@1.1.2...@appium/storage-plugin@1.1.3) (2026-05-06)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.1.2](https://github.com/appium/appium/compare/@appium/storage-plugin@1.1.1...@appium/storage-plugin@1.1.2) (2026-05-06)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.1.1](https://github.com/appium/appium/compare/@appium/storage-plugin@1.1.0...@appium/storage-plugin@1.1.1) (2026-04-23)
+
+
+### Bug Fixes
+
+* All the rest of linter warnings ([#22183](https://github.com/appium/appium/issues/22183)) ([efe167f](https://github.com/appium/appium/commit/efe167f59a0a19515b78a53346e5d0b3fc4c744c))
+
+
+
+## [1.1.0](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.6...@appium/storage-plugin@1.1.0) (2026-04-09)
+
+
+### Features
+
+* use exact version for dependencies in monorepo packages instead of ^ ([#22090](https://github.com/appium/appium/issues/22090)) ([86c8f23](https://github.com/appium/appium/commit/86c8f23a670d0bbc2d359a8235828606bd36e6aa))
+
+
+
+## [1.0.6](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.5...@appium/storage-plugin@1.0.6) (2026-03-08)
+
+
+### Bug Fixes
+
+* Type imports ([#22025](https://github.com/appium/appium/issues/22025)) ([2f27425](https://github.com/appium/appium/commit/2f27425ea300ca1af1c1da6e4be68d48e7a94346))
+
+
+
+## [1.0.5](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.4...@appium/storage-plugin@1.0.5) (2026-01-26)
+
+
+### Bug Fixes
+
+* apply npm run lint:fix ([#21867](https://github.com/appium/appium/issues/21867)) ([5e28714](https://github.com/appium/appium/commit/5e28714442cf59ee35b085e01e82c3f5483891fd))
+
+
+
+## [1.0.4](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.3...@appium/storage-plugin@1.0.4) (2025-12-04)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.0.3](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.2...@appium/storage-plugin@1.0.3) (2025-11-12)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.0.2](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.1...@appium/storage-plugin@1.0.2) (2025-10-08)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.0.1](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.0...@appium/storage-plugin@1.0.1) (2025-09-09)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [1.0.0](https://github.com/appium/appium/compare/@appium/storage-plugin@1.0.0-rc.1...@appium/storage-plugin@1.0.0) (2025-08-18)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## 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.1.3](https://github.com/appium/appium/compare/@appium/storage-plugin@0.1.2...@appium/storage-plugin@0.1.3) (2025-06-01)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [0.1.2](https://github.com/appium/appium/compare/@appium/storage-plugin@0.1.1...@appium/storage-plugin@0.1.2) (2025-04-25)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## [0.1.1](https://github.com/appium/appium/compare/@appium/storage-plugin@0.1.0...@appium/storage-plugin@0.1.1) (2025-03-17)
+
+**Note:** Version bump only for package @appium/storage-plugin
+
+
+
+
+
+## 0.1.0 (2025-03-11)
+
+
+### Features
+
+* Add storage plugin ([#21075](https://github.com/appium/appium/issues/21075)) ([ba4aa39](https://github.com/appium/appium/commit/ba4aa394d1b6676cc29644e7faa3b0590552f303))
+* **storage-plugin:** Tune the files keeping behaviour ([#21086](https://github.com/appium/appium/issues/21086)) ([15280b8](https://github.com/appium/appium/commit/15280b80d2af6b3bdf6bf2905472b05b7bca1c1d))

package/src/resources/submodules/appium/packages/storage-plugin/README.md

@@ -0,0 +1,83 @@
+# @appium/storage-plugin
+
+> Appium plugin for server-side file storage
+
+This plugin adds the ability to create a dedicated storage space on the server side,
+which can be managed from the client side. This can be useful for files like application packages.
+Only one storage may exist per server process, shared by all testing sessions.
+
+> [!WARNING]
+> This plugin is designed to be used with servers deployed in private networks.
+> Consider validating the setup with your security department
+> if you want to enable this plugin at a public Appium server deployment.
+
+## Installation
+
+```bash
+appium plugin install storage
+```
+
+## Usage
+
+Add the plugin name to the list of plugins to use upon server startup:
+
+```bash
+appium --use-plugins=storage
+```
+
+By default, the plugin creates a new temporary folder where it manages uploaded files.
+
+[Refer to the Appium documentation for the endpoints supported by this plugin.](https://appium.io/docs/en/latest/reference/api/storage-plugin/)
+
+### Storing a File
+
+The procedure for storing a local file on the Appium server is as follows:
+
+- Calculate the [SHA1](https://en.wikipedia.org/wiki/SHA-1) hash of the source file
+- Decide the name of the destination file in the server storage (it can be the same as the original file name)
+- Send a `POST` request to the `/storage/add` endpoint, which will return the `events` and `stream` websocket paths
+- Connect to both web sockets
+- Start listening for messages on the `events` web socket. Each message there is a JSON object wrapped
+  to a string. The message must be either `{"value": {"success": true, "name":"app.ipa","sha1":"ccc963411b2621335657963322890305ebe96186"}}` to notify about a successful
+  file upload, or `{"value": {"error": "<error signature>", "message": "<error message>", "traceback": "<server traceback>"}}`
+  to notify about any exceptions during the upload process.
+- Start reading the source file into small chunks. The recommended size of a single chunk is 64 KB.
+- After each chunk is retrieved, pass it to the `stream` web socket.
+- After the last chunk upload is completed, either close the `stream` web
+  socket to explicitly notify the server about the upload completion, or
+  wait until the success event is delivered from the `events` web socket
+  as soon as file hashes successfully match.
+  The server must always deliver either a success or a failure
+  event via the `events` web socket as described above.
+
+It is also possible to upload multiple files in parallel (up to 20 jobs are supported).
+Only flat files hierarchies are supported in the storage, no subfolders are allowed.
+If a file with the same name already exists in the storage, it will be overridden with the new one.
+If a folder with the same name already exists in the storage, an error will be thrown.
+
+### Environment Variables
+
+#### APPIUM_STORAGE_ROOT
+
+It is also possible to customize the repository root folder path by assigning a custom path to the
+`APPIUM_STORAGE_ROOT` environment variable upon server startup. The plugin automatically deletes the
+root folder recursively upon server process termination, unless the server is
+killed forcefully. If `APPIUM_STORAGE_ROOT` points to an existing folder,
+then all files there are going to be preserved by default unless a different behavior is
+requested by [APPIUM_STORAGE_KEEP_ALL](#appium_storage_keep_all) environment variable value.
+
+#### APPIUM_STORAGE_KEEP_ALL
+
+If this environment variable is set to `true`, `1` or `yes` then the plugin will always keep
+storage files after the server process is terminated. All other
+values of this variable enforce the plugin to always delete all files
+from the storage folder.
+
+## Examples
+
+Check [integration tests](./test/e2e/storage.e2e.spec.cjs) for a working
+[WebdriverIO](https://webdriver.io/) example.
+
+## License
+
+Apache-2.0

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

@@ -0,0 +1,129 @@
+# 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.1](https://github.com/appium/appium/compare/@appium/strongbox@1.1.0...@appium/strongbox@1.1.1) (2026-04-23)
+
+
+### Bug Fixes
+
+* All the rest of linter warnings ([#22183](https://github.com/appium/appium/issues/22183)) ([efe167f](https://github.com/appium/appium/commit/efe167f59a0a19515b78a53346e5d0b3fc4c744c))
+
+
+
+## [1.1.0](https://github.com/appium/appium/compare/@appium/strongbox@1.0.2...@appium/strongbox@1.1.0) (2026-04-09)
+
+
+### Features
+
+* **strongbox:** Add a possibility to list strongbox items ([#22091](https://github.com/appium/appium/issues/22091)) ([73b7820](https://github.com/appium/appium/commit/73b7820df57d6d4a3f345230b4ae406615e3f951))
+
+
+
+## [1.0.2](https://github.com/appium/appium/compare/@appium/strongbox@1.0.1...@appium/strongbox@1.0.2) (2026-03-08)
+
+
+### Bug Fixes
+
+* Type imports ([#22025](https://github.com/appium/appium/issues/22025)) ([2f27425](https://github.com/appium/appium/commit/2f27425ea300ca1af1c1da6e4be68d48e7a94346))
+
+
+
+## [1.0.1](https://github.com/appium/appium/compare/@appium/strongbox@1.0.0...@appium/strongbox@1.0.1) (2026-01-26)
+
+**Note:** Version bump only for package @appium/strongbox
+
+
+
+
+
+## [1.0.0](https://github.com/appium/appium/compare/@appium/strongbox@1.0.0-rc.1...@appium/strongbox@1.0.0) (2025-08-18)
+
+**Note:** Version bump only for package @appium/strongbox
+
+
+
+
+
+## [1.0.0-rc.1](https://github.com/appium/appium/compare/@appium/strongbox@0.3.3...@appium/strongbox@1.0.0-rc.1) (2025-08-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* set minimum Node.js version to v20.19.0 (#21394)
+
+### Features
+
+* **base-driver:** Make extension name prefix mandatory ([#21110](https://github.com/appium/appium/issues/21110)) ([9402291](https://github.com/appium/appium/commit/9402291f1c634bcb376ff69aef7a7b4d0628cbd4))
+
+
+### Bug Fixes
+
+* Reduce linter warnings ([#20860](https://github.com/appium/appium/issues/20860)) ([65658cc](https://github.com/appium/appium/commit/65658ccbdde9144c45cb5aad6a9089a5d6f3a0a3))
+
+
+### 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.4](https://github.com/appium/appium/compare/@appium/strongbox@0.3.3...@appium/strongbox@0.3.4) (2025-06-01)
+
+
+### Bug Fixes
+
+* Reduce linter warnings ([#20860](https://github.com/appium/appium/issues/20860)) ([65658cc](https://github.com/appium/appium/commit/65658ccbdde9144c45cb5aad6a9089a5d6f3a0a3))
+
+
+
+## [0.3.3](https://github.com/appium/appium/compare/@appium/strongbox@0.3.2...@appium/strongbox@0.3.3) (2024-07-10)
+
+**Note:** Version bump only for package @appium/strongbox
+
+
+
+
+
+## [0.3.2](https://github.com/appium/appium/compare/@appium/strongbox@0.3.1...@appium/strongbox@0.3.2) (2023-12-18)
+
+**Note:** Version bump only for package @appium/strongbox
+
+
+
+
+
+## [0.3.1](https://github.com/appium/appium/compare/@appium/strongbox@0.3.0...@appium/strongbox@0.3.1) (2023-06-14)
+
+
+### Bug Fixes
+
+* **strongbox:** do not force-lowercase slugged containers ([1ccf857](https://github.com/appium/appium/commit/1ccf857a4bdd77af3ccf2ad268e3410855509af8))
+
+
+
+## [0.3.0](https://github.com/appium/appium/compare/@appium/strongbox@0.2.0...@appium/strongbox@0.3.0) (2023-04-20)
+
+
+### ⚠ BREAKING CHANGES
+
+* **strongbox:** The signature for an `ItemCtor` has changed. The second parameter is now a type extending `Strongbox` instead of a `container` string.  This allows for deeper integration between a custom `Item` implementation and a custom `Strongbox` implementation. Further, a custom `container` now must be an absolute path after it's been slugified.
+
+- The `Strongbox.clearAll()` method now accepts a `force` param which, if `true`, will rimraf the entire container.
+- Added two methods to the `Strongbox` class which can be overridden to accept custom options, apply defaults to those options, then validate and/or transform them.
+- Added nearly-complete unit test coverage and added E2E coverage of the `BaseItem` implementation.
+
+### Features
+
+* **strongbox:** allow rimraf of entire container ([93bddb4](https://github.com/appium/appium/commit/93bddb4c73ab16fffda09909786074b9e5f2b7e5))
+
+
+
+# 0.2.0 (2023-04-10)
+
+
+### Features
+
+* **strongbox:** create @appium/strongbox ([fd91234](https://github.com/appium/appium/commit/fd912346fade8f29f5b4d1458828ea677d7e9fcc))
+* **strongbox:** export BaseItem ([377e982](https://github.com/appium/appium/commit/377e9825de74d9929631fb331e6d348c9df0964e))

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

@@ -0,0 +1,110 @@
+# @appium/strongbox
+
+> Persistent storage for Appium extensions
+
+## Summary
+
+This package is intended to be used in [Appium](https://appium.io) extensions which need to persist data between Appium runs.  An example of such data may be a device token or key.  
+
+`@appium/strongbox` provides a simple and extensible API for managing such data, while abstracting the underlying storage mechanism.
+
+_Note:_ This module is not intended for storing sensitive data.
+
+## Usage
+
+First, create an instance of `Strongbox`:
+
+```ts
+import {strongbox} from '@appium/strongbox';
+
+const box = strongbox('my-pkg');
+```
+
+This instance corresponds to a unique collection of data.
+
+From here, create a placeholder for data (you will need to provide the type of data you intend to store):
+
+```ts
+const item = await box.createItem<string>('my unique name');
+```
+
+...or, if you already have the data on-hand:
+
+```ts
+const item: Buffer|string = getSomeData();
+
+const item = await box.createItemWithContents('my unique name', data);
+```
+
+Either way, you can read its contents:
+
+```ts
+// if the item doesn't exist, this result will be undefined
+const contents = await item.read();
+```
+
+Or write new data to the item:
+
+```ts
+await item.write('new stuff');
+```
+
+To list persisted items without knowing their names in advance:
+
+```ts
+const items = await box.listItems();
+```
+
+`listItems` does not read each file’s contents; call `read()` on an item when you need them. Item order follows the filesystem directory walk (not lexicographic). It returns every item in one array; for large containers that can use a lot of memory, prefer async iteration, which streams directory entries with `opendir` instead of buffering all names first:
+
+```ts
+for await (const item of box) {
+  // ...
+}
+```
+
+The last-read contents of the `Item` will be available on the `contents` property, but the value of this property is only current as of the last `read()`:
+
+```ts
+const {contents} = item;
+```
+
+## API
+
+In lieu of actual documentation, look at the type definitions that this package ships.
+
+## Customization
+
+1. Create a class that implements the `Item` interface:
+
+    ```ts
+    import {strongbox, Item} from '@appium/strongbox';
+    import {Foo, getFoo} from 'somewhere/else';
+
+    class FooItem implements Item<Foo> {
+      // ...
+    }
+    ```
+
+2. Provide this class as the `defaultCtor` option to `strongbox()`:
+
+    ```ts
+    const box = strongbox('my-pkg', {defaultCtor: FooItem});
+    ```
+
+3. Use like you would any other `Strongbox` instance:
+
+    ```ts
+    const foo: Foo = getFoo();
+    const item = await box.createItemWithValue('my unique name', Foo);
+    ```
+
+## Default Behavior, For the Curious
+
+Out-of-the-box, a `Strongbox` instance corresponds to a directory on-disk, and each `Item` (returned by `createItem()/createItemWithContents()`) corresponds to a file within that directory.  
+
+The directory of the `Strongbox` instance is determined by the [env-paths](https://www.npmjs.com/package/env-paths) package, and is platform-specific.
+
+## License
+
+Copyright © 2023 OpenJS Foundation. Licensed Apache-2.0