@appium/mcp-documentation 1.0.3 → 1.0.4

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

@@ -0,0 +1,446 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [4.1.5](https://github.com/appium/appium/compare/@appium/opencv@4.1.4...@appium/opencv@4.1.5) (2026-05-31)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.1.4](https://github.com/appium/appium/compare/@appium/opencv@4.1.3...@appium/opencv@4.1.4) (2026-05-06)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.1.3](https://github.com/appium/appium/compare/@appium/opencv@4.1.2...@appium/opencv@4.1.3) (2026-04-23)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.1.2](https://github.com/appium/appium/compare/@appium/opencv@4.1.1...@appium/opencv@4.1.2) (2026-04-09)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.1.1](https://github.com/appium/appium/compare/@appium/opencv@4.1.0...@appium/opencv@4.1.1) (2026-03-08)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.1.0](https://github.com/appium/appium/compare/@appium/opencv@4.0.3...@appium/opencv@4.1.0) (2026-01-26)
+
+
+### Features
+
+* **opencv:** Migrate to typescript ([#21881](https://github.com/appium/appium/issues/21881)) ([fec5f3a](https://github.com/appium/appium/commit/fec5f3a377de4804920f5e8293ae5f198a7d4473))
+
+
+### Bug Fixes
+
+* apply npm run lint:fix ([#21867](https://github.com/appium/appium/issues/21867)) ([5e28714](https://github.com/appium/appium/commit/5e28714442cf59ee35b085e01e82c3f5483891fd))
+
+
+
+## [4.0.3](https://github.com/appium/appium/compare/@appium/opencv@4.0.2...@appium/opencv@4.0.3) (2025-11-12)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.0.2](https://github.com/appium/appium/compare/@appium/opencv@4.0.1...@appium/opencv@4.0.2) (2025-10-08)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.0.1](https://github.com/appium/appium/compare/@appium/opencv@4.0.0...@appium/opencv@4.0.1) (2025-09-09)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.0.0](https://github.com/appium/appium/compare/@appium/opencv@4.0.0-rc.1...@appium/opencv@4.0.0) (2025-08-18)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [4.0.0-rc.1](https://github.com/appium/appium/compare/@appium/opencv@3.0.8...@appium/opencv@4.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))
+
+
+### 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))
+
+
+
+## [3.0.10](https://github.com/appium/appium/compare/@appium/opencv@3.0.9...@appium/opencv@3.0.10) (2025-06-01)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.9](https://github.com/appium/appium/compare/@appium/opencv@3.0.8...@appium/opencv@3.0.9) (2025-04-25)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.8](https://github.com/appium/appium/compare/@appium/opencv@3.0.7...@appium/opencv@3.0.8) (2025-02-19)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.7](https://github.com/appium/appium/compare/@appium/opencv@3.0.6...@appium/opencv@3.0.7) (2025-01-02)
+
+
+### Bug Fixes
+
+* Reduce linter warnings ([#20860](https://github.com/appium/appium/issues/20860)) ([65658cc](https://github.com/appium/appium/commit/65658ccbdde9144c45cb5aad6a9089a5d6f3a0a3))
+
+
+
+## [3.0.6](https://github.com/appium/appium/compare/@appium/opencv@3.0.5...@appium/opencv@3.0.6) (2024-09-16)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.5](https://github.com/appium/appium/compare/@appium/opencv@3.0.4...@appium/opencv@3.0.5) (2024-07-10)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.4](https://github.com/appium/appium/compare/@appium/opencv@3.0.3...@appium/opencv@3.0.4) (2024-05-27)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.3](https://github.com/appium/appium/compare/@appium/opencv@3.0.2...@appium/opencv@3.0.3) (2024-04-08)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.2](https://github.com/appium/appium/compare/@appium/opencv@3.0.1...@appium/opencv@3.0.2) (2024-02-06)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.1](https://github.com/appium/appium/compare/@appium/opencv@3.0.0...@appium/opencv@3.0.1) (2024-01-03)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [3.0.0](https://github.com/appium/appium/compare/@appium/opencv@2.1.6...@appium/opencv@3.0.0) (2023-12-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* **images-plugin,opencv:** Drop support for Node 14 and Node 16
+
+* chore: adjust engine ranges to current LTS
+
+* chore: update package-lock.json
+
+### Bug Fixes
+
+* **docutils:** remove `@appium/typedoc-plugin-appium` and all other uses of `typedoc` ([#19465](https://github.com/appium/appium/issues/19465)) ([7528fcf](https://github.com/appium/appium/commit/7528fcf890f79f4017f5e718bb1952bf907ee479))
+
+
+### Miscellaneous Chores
+
+* **images-plugin,opencv:** update dependency sharp to 0.33.0 ([#19498](https://github.com/appium/appium/issues/19498)) ([73d0aa5](https://github.com/appium/appium/commit/73d0aa5d1cd8b3b0e72b879308fd215fb03f428d))
+
+
+
+## [2.1.6](https://github.com/appium/appium/compare/@appium/opencv@2.1.5...@appium/opencv@2.1.6) (2023-11-14)
+
+
+### Bug Fixes
+
+* **support:** update definitelytyped ([5ae8df3](https://github.com/appium/appium/commit/5ae8df3c36c7f03fbf3420087b532086f6742348))
+
+
+
+## [2.1.5](https://github.com/appium/appium/compare/@appium/opencv@2.1.4...@appium/opencv@2.1.5) (2023-10-19)
+
+
+### Bug Fixes
+
+* **support:** update definitelytyped ([a306ce7](https://github.com/appium/appium/commit/a306ce741a806d21bc44f3b979803b8af5da99aa))
+
+
+
+## [2.1.4](https://github.com/appium/appium/compare/@appium/opencv@2.1.3...@appium/opencv@2.1.4) (2023-10-18)
+
+
+### Bug Fixes
+
+* **opencv:** update definitelytyped ([d2a9a99](https://github.com/appium/appium/commit/d2a9a99418af9ce9b569bb9b98ee396faab932bb))
+* **support:** update definitelytyped ([b6a76ce](https://github.com/appium/appium/commit/b6a76ce91e2765c22f84e389b93f780e0b4490c0))
+
+
+
+## [2.1.3](https://github.com/appium/appium/compare/@appium/opencv@2.1.2...@appium/opencv@2.1.3) (2023-08-21)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.1.2](https://github.com/appium/appium/compare/@appium/opencv@2.1.1...@appium/opencv@2.1.2) (2023-08-17)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.1.1](https://github.com/appium/appium/compare/@appium/opencv@2.1.0...@appium/opencv@2.1.1) (2023-06-14)
+
+
+### Bug Fixes
+
+* Do not use additional checks on opencv objects ([#18714](https://github.com/appium/appium/issues/18714)) ([38f8690](https://github.com/appium/appium/commit/38f86900da462a444ae5a9c92794f64a297f79bd))
+
+
+
+## [2.1.0](https://github.com/appium/appium/compare/@appium/opencv@2.0.10...@appium/opencv@2.1.0) (2023-05-17)
+
+
+### Features
+
+* **image-plugin:** Make it possible to find elements inside of other elements ([#18555](https://github.com/appium/appium/issues/18555)) ([2796639](https://github.com/appium/appium/commit/2796639b1183f0efbae8d7adb6d24570d5d4fde4))
+
+
+### Bug Fixes
+
+* **opencv:** Make sure allocated CV objects are properly released afterwards ([#18569](https://github.com/appium/appium/issues/18569)) ([2fb844c](https://github.com/appium/appium/commit/2fb844c8ad5ea1e36c326ce5cf46869c0ff0d4f9))
+* **opencv:** update dependency sharp to v0.32.1 ([add0eaa](https://github.com/appium/appium/commit/add0eaa05f476a5f2708925a43f2bc16cad75872))
+
+
+
+## [2.0.10](https://github.com/appium/appium/compare/@appium/opencv@2.0.9...@appium/opencv@2.0.10) (2023-04-05)
+
+
+### Bug Fixes
+
+* **opencv:** fix a type error causing typedoc problems ([bb11d1c](https://github.com/appium/appium/commit/bb11d1cfe9681ccd457f0677118725a6e9ddd72f))
+
+
+
+
+
+## [2.0.9](https://github.com/appium/appium/compare/@appium/opencv@2.0.8...@appium/opencv@2.0.9) (2023-04-03)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.0.8](https://github.com/appium/appium/compare/@appium/opencv@2.0.7...@appium/opencv@2.0.8) (2023-03-08)
+
+
+### Bug Fixes
+
+* **support:** update dependency jimp to v0.22.7 ([188ed16](https://github.com/appium/appium/commit/188ed161e4156aab4381b27fcb6f6d1fccbc0e73))
+
+
+
+
+
+## [2.0.7](https://github.com/appium/appium/compare/@appium/opencv@2.0.6...@appium/opencv@2.0.7) (2023-02-24)
+
+
+### Bug Fixes
+
+* **support:** update dependency jimp to v0.22.5 ([998514f](https://github.com/appium/appium/commit/998514fccee0b1a7381b810280cbc30558c3c282))
+
+
+
+
+
+## [2.0.6](https://github.com/appium/appium/compare/@appium/opencv@2.0.5...@appium/opencv@2.0.6) (2023-02-09)
+
+
+### Bug Fixes
+
+* **support:** update dependency jimp to v0.16.13 ([9ce3263](https://github.com/appium/appium/commit/9ce32639187fcd7195216ccf7393caba1b1ef48c))
+* **support:** update dependency jimp to v0.17.10 ([8129a22](https://github.com/appium/appium/commit/8129a228a9a76c4b9d94402b8d6fa106777d7bbf))
+* **support:** update dependency jimp to v0.21.0 ([9bc1fbd](https://github.com/appium/appium/commit/9bc1fbdf3d881fbdc32be1e1466d6ec367959340))
+* **support:** update dependency jimp to v0.21.3 ([3b4d9dd](https://github.com/appium/appium/commit/3b4d9dde6080569f05057bdb1bb600c2a0cf8eb6))
+* **support:** update dependency jimp to v0.22.4 ([742abf2](https://github.com/appium/appium/commit/742abf25035fe5ea5aa280c1ed09ffec5d4f97cf))
+
+
+
+
+
+## [2.0.5](https://github.com/appium/appium/compare/@appium/opencv@2.0.4...@appium/opencv@2.0.5) (2023-01-13)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.0.4](https://github.com/appium/appium/compare/@appium/opencv@2.0.3...@appium/opencv@2.0.4) (2023-01-13)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.0.3](https://github.com/appium/appium/compare/@appium/opencv@2.0.2...@appium/opencv@2.0.3) (2023-01-13)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.0.2](https://github.com/appium/appium/compare/@appium/opencv@2.0.1...@appium/opencv@2.0.2) (2023-01-13)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
+## [2.0.1](https://github.com/appium/appium/compare/@appium/opencv@2.0.0...@appium/opencv@2.0.1) (2022-12-21)
+
+**Note:** Version bump only for package @appium/opencv
+
+# [2.0.0](https://github.com/appium/appium/compare/@appium/opencv@1.0.13...@appium/opencv@2.0.0) (2022-12-14)
+
+### Bug Fixes
+
+- **opencv,support:** override jpeg-js version ([125a68f](https://github.com/appium/appium/commit/125a68fe47ea6f5a936fe8d2e8b6cd5303bfb875))
+- **opencv:** update definitelytyped ([32557f4](https://github.com/appium/appium/commit/32557f4bca5acc2f89cfd3a70f369cebeb94c588))
+
+- chore!: set engines to minimum Node.js v14.17.0 ([a1dbe6c](https://github.com/appium/appium/commit/a1dbe6c43efe76604943a607d402f4c8b864d652))
+
+### Features
+
+- experimental support for typedoc generation ([4746080](https://github.com/appium/appium/commit/4746080e54ed8bb494cbc7c6ce83db503bf6bb52))
+
+### BREAKING CHANGES
+
+- Appium now supports version range `^14.17.0 || ^16.13.0 || >=18.0.0`
+
+## [1.0.13](https://github.com/appium/appium/compare/@appium/opencv@1.0.12...@appium/opencv@1.0.13) (2022-10-13)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.12](https://github.com/appium/appium/compare/@appium/opencv@1.0.11...@appium/opencv@1.0.12) (2022-09-07)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.11](https://github.com/appium/appium/compare/@appium/opencv@1.0.10...@appium/opencv@1.0.11) (2022-08-03)
+
+### Bug Fixes
+
+- **appium,base-driver,base-plugin,doctor,docutils,eslint-config-appium,execute-driver-plugin,fake-driver,fake-plugin,gulp-plugins,images-plugin,opencv,relaxed-caps-plugin,schema,support,test-support,types,universal-xml-plugin:** update engines ([d8d2382](https://github.com/appium/appium/commit/d8d2382327ba7b7db8a4d1cad987c0e60184c92d))
+
+## [1.0.10](https://github.com/appium/appium/compare/@appium/opencv@1.0.9...@appium/opencv@1.0.10) (2022-07-28)
+
+### Bug Fixes
+
+- moved type packages to deps of specific packages ([f9129df](https://github.com/appium/appium/commit/f9129dfee32fcc3f89ffcfa69fb83b7c2419c24f))
+
+## [1.0.9](https://github.com/appium/appium/compare/@appium/opencv@1.0.8...@appium/opencv@1.0.9) (2022-05-31)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.8](https://github.com/appium/appium/compare/@appium/opencv@1.0.7...@appium/opencv@1.0.8) (2022-05-31)
+
+### Bug Fixes
+
+- **appium:** fix extension autoinstall postinstall script ([3e2c05d](https://github.com/appium/appium/commit/3e2c05d8a290072484afde34fe5fd968618f6359)), closes [#16924](https://github.com/appium/appium/issues/16924)
+
+## [1.0.7](https://github.com/appium/appium/compare/@appium/opencv@1.0.6...@appium/opencv@1.0.7) (2022-04-20)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.6](https://github.com/appium/appium/compare/@appium/opencv@1.0.5...@appium/opencv@1.0.6) (2022-04-20)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.5](https://github.com/appium/appium/compare/@appium/opencv@1.0.4...@appium/opencv@1.0.5) (2022-04-20)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.4](https://github.com/appium/appium/compare/@appium/opencv@1.0.3...@appium/opencv@1.0.4) (2022-04-12)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.3](https://github.com/appium/appium/compare/@appium/opencv@1.0.2...@appium/opencv@1.0.3) (2022-04-07)
+
+**Note:** Version bump only for package @appium/opencv
+
+## [1.0.2](https://github.com/appium/appium/compare/@appium/opencv@1.0.1...@appium/opencv@1.0.2) (2022-03-22)
+
+**Note:** Version bump only for package @appium/opencv
+
+## 1.0.1 (2022-01-21)
+
+**Note:** Version bump only for package @appium/opencv

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

@@ -0,0 +1,68 @@
+# @appium/opencv
+
+> OpenCV-related helper methods
+
+[![NPM version](http://img.shields.io/npm/v/@appium/opencv.svg)](https://npmjs.org/package/@appium/opencv)
+[![Downloads](http://img.shields.io/npm/dm/@appium/opencv.svg)](https://npmjs.org/package/@appium/opencv)
+
+## Installation
+
+`npm install @appium/opencv`
+
+## Usage
+
+### initOpenCv
+
+Loads the opencv bindings. You only need to explicitly call this if you want to use your own opencv
+methods that are not included in this module.
+
+```js
+import {initOpenCv} from '@appium/opencv';
+await initOpenCv();
+```
+
+### getImagesMatches
+
+Calculates the count of common edges between two images. The images might be rotated or resized
+relatively to each other. See the function definition for more details.
+
+```js
+import {getImagesMatches} from '@appium/opencv';
+import {fs} from '@appium/support';
+
+const image1 = await fs.readFile('image1.jpg')
+const image2 = await fs.readFile('image2.jpg')
+const {points1, rect1, points2, rect2, totalCount, count} = await getImagesMatches(image1, image2);
+```
+
+### getImagesSimilarity
+
+Calculates the similarity score between two images. It is expected that both images have the same
+resolution. See the function definition for more details.
+
+```js
+import {getImagesSimilarity} from '@appium/opencv';
+import {fs} from '@appium/support';
+
+const image1 = await fs.readFile('image1.jpg')
+const image2 = await fs.readFile('image2.jpg')
+const {score} = await getImagesSimilarity(image1, image2);
+```
+
+### getImageOccurrence
+
+Calculates the occurrence position of a partial image in the full image. See the function definition
+for more details.
+
+```js
+import {getImageOccurrence} from '@appium/opencv';
+import {fs} from '@appium/support';
+
+const fullImage = await fs.readFile('image1.jpg')
+const partialImage = await fs.readFile('image2.jpg')
+const {rect, score} = await getImageOccurrence(fullImage, partialImage);
+```
+
+## License
+
+Apache-2.0