appium-mcp 0.0.1 → 1.1.5

package/src/resources/index.ts

@@ -0,0 +1,7 @@
+// Export all resources
+import javaTemplatesResource from './java/template.js';
+
+export default function registerResources(server: any) {
+  javaTemplatesResource(server);
+  console.log('All resources registered');
+}

package/src/resources/java/template.ts

@@ -0,0 +1,83 @@
+/**
+ * Resource for Java template files
+ */
+export default function javaTemplatesResource(server: any) {
+  server.addResource({
+    uri: 'generate://code-with-locators',
+    name: 'Generate Code With Locators',
+    description: `Generate code for the current page with locators which was retrieved from generate_locators tool.
+    The code should be generated in the same priorty order as the locators were generated.
+    For iOS the priority order is:
+      'id',
+      'accessibility id',
+      '-ios predicate string',
+      '-ios class chain',
+      'xpath',
+      'class name',
+    For Android the priority order is:
+       'id',
+      'accessibility id',
+      'xpath',
+      '-android uiautomator',
+      'class name',
+    which follows the page factory pattern. Dont not strictly create test cases, just generate the code for locators.`,
+    mimeType: 'text/plain',
+    async load() {
+      // Return all content directly without templates object
+      return {
+        message:
+          'Java templates for mobile automation, use this and generate code for the current page',
+        instruction:
+          'Use these templates to generate code for the current page',
+        text: `
+package templates;
+
+import io.appium.java_client.AppiumDriver;
+import io.appium.java_client.pagefactory.AndroidFindBy;
+import io.appium.java_client.pagefactory.AppiumFieldDecorator;
+import io.appium.java_client.pagefactory.iOSXCUITFindBy;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.support.PageFactory;
+
+import java.time.Duration;
+
+/**
+ * This class demonstrates using PageFactory with Appium for cross-platform
+ * mobile app locators using @AndroidFindBy and @iOSXCUITFindBy annotations.
+ * Example: 
+ */
+public class locators {
+
+    // ========== LOGIN SCREEN ELEMENTS ==========
+
+    /**
+     * Username input field
+     * - Android: accessibility id = "username_input"
+     * - iOS: accessibility id = "username_input"
+     */
+    @AndroidFindBy(accessibility = "username_input")
+    @iOSXCUITFindBy(accessibility = "username_input")
+    
+
+    public WebElement usernameField;
+
+    @iOSXCUITFindBy(iOSNsPredicate = "name = 'IntegerB'")
+    private WebElement textField2;
+
+    @iOSXCUITFindBy(iOSClassChain = "XCUIElementTypeWindow/*/XCUIElementTypeTextField[2]")
+    private WebElement secondTextField;
+
+    /**
+     * Constructor that initializes the PageFactory
+     * 
+     * @param driver AppiumDriver instance
+     */
+    public locators(AppiumDriver driver) {
+        PageFactory.initElements(new AppiumFieldDecorator(driver, Duration.ofSeconds(10)), this);
+    }
+}
+    `,
+      };
+    },
+  });
+}

package/src/resources/submodules/appium/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce to Appium?
+_Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation Update (if none of the other choices apply)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [Contributing Guide](https://appium.io/docs/en/latest/contributing/)
+- [ ] I have signed the CLA
+- [ ] Lint and unit tests pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added the necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

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

@@ -0,0 +1,45 @@
+# Aggregate Changelog
+
+The Appium monorepo contains many different modules and supports a variety of drivers, plugins and clients,
+most of which have their own changelogs. Links to these individual changelogs are aggregated here.
+
+## Main Appium Module
+
+* ### [Appium Changelog](packages/appium/CHANGELOG.md)
+* [Appium 1.x Changelog](https://github.com/appium/appium/blob/1.x/CHANGELOG.md)
+
+## Drivers / Clients
+Refer to the [Appium Ecosystem](https://appium.io/docs/en/latest/ecosystem/) page for links
+to driver/client documentation
+
+## Plugins
+* [execute-driver-plugin](packages/execute-driver-plugin/CHANGELOG.md)
+* [images-plugin](packages/images-plugin/CHANGELOG.md)
+* [relaxed-caps-plugin](packages/relaxed-caps-plugin/CHANGELOG.md)
+* [storage-plugin](packages/storage-plugin/CHANGELOG.md)
+* [universal-xml-plugin](packages/universal-xml-plugin/CHANGELOG.md)
+
+## Other Modules
+* [base-driver](packages/base-driver/CHANGELOG.md)
+* [base-plugin](packages/base-plugin/CHANGELOG.md)
+* [docutils](packages/docutils/CHANGELOG.md)
+* [driver-test-support](packages/driver-test-support/CHANGELOG.md)
+* [eslint-config-appium-ts](packages/eslint-config-appium-ts/CHANGELOG.md)
+* [fake-driver](packages/fake-driver/CHANGELOG.md)
+* [fake-plugin](packages/fake-plugin/CHANGELOG.md)
+* [logger](packages/logger/CHANGELOG.md)
+* [opencv](packages/opencv/CHANGELOG.md)
+* [plugin-test-support](packages/plugin-test-support/CHANGELOG.md)
+* [schema](packages/schema/CHANGELOG.md)
+* [strongbox](packages/strongbox/CHANGELOG.md)
+* [support](packages/support/CHANGELOG.md)
+* [test-support](packages/test-support/CHANGELOG.md)
+* [tsconfig](packages/tsconfig/CHANGELOG.md)
+* [types](packages/types/CHANGELOG.md)
+
+## Removed Modules
+The changelog links used for these modules lead to the last version of their changelog file.
+* [doctor](https://github.com/appium/appium/blob/8daf5e123ac14c8325acf504fb33eb28e1a3dd78/packages/doctor/CHANGELOG.md) ([removal PR](https://github.com/appium/appium/pull/20805))
+* [eslint-config-appium](https://github.com/appium/appium/blob/4b3a8c2197a587ec5a2606b662e4e7667a7852cb/packages/eslint-config-appium/CHANGELOG.md) ([removal PR](https://github.com/appium/appium/pull/20856))
+* [gulp-plugins](https://github.com/appium/appium/blob/0823f0b60e40395cd1dc3b72cfa3c0092bc81302/packages/gulp-plugins/CHANGELOG.md) ([removal PR](https://github.com/appium/appium/pull/17943))
+* [typedoc-plugin-appium](https://github.com/appium/appium/blob/d6204b6902074210943d7bbbf72d139b9b170a20/packages/typedoc-plugin-appium/CHANGELOG.md) ([removal PR](https://github.com/appium/appium/pull/19465))

package/src/resources/submodules/appium/CONDUCT.md

@@ -0,0 +1,48 @@
+## Code of Conduct
+
+### What is this code of conduct for?
+
+Appium is a piece of technology, but **the core of the Appium community is the people in it**. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, gender identity and expression, sexual orientation, ability, physical appearance, body size, race, age, socioeconomic status, religion (or lack thereof), or other marginalized aspect of community members. We expect all members of the Appium community to abide by this Code of Conduct whenever interacting in Appium venues (pull requests, GitHub issues, 1-1 or group chat, meetups, conferences, etc...)
+
+### Examples of inappropriate behavior
+
+Because we come from a variety of backgrounds, we don't want to assume that everyone has the same assumptions about what is and isn't appropriate. Here are some examples of inappropriate behavior that are incompatible with our community's ethos:
+
+* Spamming, trolling, intentionally disrupting conversations, or irrelevant solicitation or advertisement
+* Making demeaning or discriminatory comments
+* Making negative assumptions about someone's background, abilities, or intentions
+* Harassing or stalking individuals (online or in person)
+* Giving someone unwelcome sexual attention or making unwelcome physical contact (in the case of an IRL event)
+* Sharing sexual images or using sexually explicit language
+
+In general: treat others how you would like to be treated, were you in their place. Don't be a jerk. _Do_ ask questions. _Do_ keep conflicts productively focused on technical issues. _Do_ think before you speak; remember that what is perceived as a funny witticism in your group of friends might be hurtful or reinforce hurtful stereotypes in the context of our diverse online community. _Do_ remember that we are all people, not robots, and all equally deserving of sensitivity and respect. (If and when robots join our community, let's treat them with respect too!)
+
+
+### What will organizers do about inappropriate behavior?
+
+If we notice you doing or saying something inappropriate, an organizer will explain why it's inappropriate and ask you to stop. We won't demonize or vilify you. But please do stop the inappropriate behavior so we can get back to writing and discussing code in a safe environment. If you have philosophical disagreements about what's actually inappropriate, please take them to a separate public or private conversation with an Appium maintainer so we don't turn pull requests into an ethics debate.
+
+If you keep doing unacceptable things, we'll likely ban you, report you to GitHub, or take other appropriate action.
+
+### What if I see or am subject to what feels like inappropriate behavior?
+
+Let us know! Please notify a community organizer as soon as possible. Full contact information is listed in the [Contact Info](#contact-info) section of this document. All communications will be kept strictly confidential, unless otherwise required by law. No issue will be considered too inconsequential or unimportant for us to have a conversation about.
+
+### Contact Info
+
+If you need to report an incident, please contact any of the following organizers directly:
+
+* Isaac Murchie [email](mailto:isaac@saucelabs.com) [twitter](https://twitter.com/imurchie)
+* Jonathan Lipps [email](mailto:jlipps@saucelabs.com) [twitter](https://twitter.com/jlipps)
+
+### Credit, License, and Attribution
+
+This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+It's inspired among other things by:
+* [Citizen Code of Conduct](http://citizencodeofconduct.org/)
+* [npmjs](https://www.npmjs.com/policies/conduct)
+* [Geek Feminism](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy)
+* [Ashe Dryden](http://www.ashedryden.com/blog/codes-of-conduct-101-faq)
+* [Model View Culture](https://modelviewculture.com/issues/events)
+* [Open Source & Feelings](http://osfeels.com/conduct).

package/src/resources/submodules/appium/GOVERNANCE.md

@@ -0,0 +1,185 @@
+# Appium Project Governance
+
+The Appium Project wants as much as possible to operate using procedures that
+are fair, open, inviting, and ultimately good for the community. For that
+reason we find it valuable to codify some of the ways that the Project goes
+about its day-to-day business. We want to make sure that no matter who you are,
+you have the opportunity to contribute to Appium. We want to make sure that no
+one corporation can exert undue influence on the community or hold the Project
+hostage. And likewise we want to make sure that corporations which benefit from
+Appium are also incentivized to give back.
+
+### The Technical Committee
+
+The project is officially led by a Technical Committee (TC), currently
+consisting of:
+
+* [@jlipps](https://github.com/jlipps)
+* [@mykola-mokhnach](https://github.com/mykola-mokhnach)
+* [@eglitise](https://github.com/eglitise)
+* [@KazuCocoa](https://github.com/KazuCocoa)
+
+They all represent different companies and different types of contribution to
+the Appium Project. The TC is responsible for high-level decisions (like
+establishing a feature roadmap, accepting sponsorship, organizing conferences,
+etc...), adjudicating conflicts between members of the community, and making
+changes to the project's governance processes.
+
+* Membership in the TC is granted by unanimous vote of current TC members.
+* TC members can step down at any time.
+* No more than 1/3 (or 2, whichever is higher) of TC members may belong to the same company.
+* Changes to project governance require unanimous vote of the TC.
+
+### Project Committers
+
+Most of the project maintenance is handled by committers, community members who
+have been granted commit access to the Appium organization on GitHub. The
+responsibilities of committers include: reviewing and merging pull requests,
+walking through changes with developers, weighing in on architectural issues,
+and so on.
+
+* Any two TC members can decide to make someone a project committer, providing that person has shown an appropriate understanding of the Appium codebase through prior contributions of code.
+* In general any committer can review and merge a PR. In general committers should only merge code they are qualified to review, which might entail pinging another committer who has greater ownership over a specific code area.
+* Debates between committers about whether code should be merged should happen in GitHub pull requests.
+* Proposals for large changes to the project's code (architectural changes, etc...) should be brought forward as a GitHub issue (with the label `Proposal`), and all committers should be pinged so they can weigh in on the discussion if desired. Substantial changes, whether in proposal stage or in pull request stage should be signed off on by 1 TC member and at least 2 other committers. To assist in the discussion, a small proof of concept can be undertaken on a subset of the Appium ecosystem and raised as a strawman PR, to give flesh to the proposal and make discussion more helpfully concrete.
+* In general disputes about code should be resolved by discussion, not votes. If there is substantial disagreement, aim for consensus. If that is not possible, committers can bring the dispute to the TC for a vote, with the outcome determined by a majority.
+* Any committer can decide to close a PR or issue if they determine the change doesn't suit the project.
+* Appium has a large ecosystem of repositories. Some are 'core' in the sense of being central subpackages with a lot of traffic like `appium/appium` or `appium/appium-ios-driver`. Others are 'peripheral' in the sense of receiving few changes, being maintained by 1 person or no one, etc..., like `appium/ruby_lib` or `appium/appium_thor` For 'core' repos, committers should not merge their own code straightaway. Like all contributors they should open a PR and get a +1 from another committer. For 'peripheral' repos for which they are the sole maintainer or for which they have a good understanding, it is obtuse to insist on another contributor's +1 and this rule should be relaxed in that case. In sum: use good judgment and don't ram code through without a review when you can help it.
+
+The current committers are (along with their primary areas(s) of ownership or maintenance):
+
+* [@dan-maor](https://github.com/Dan-Maor) - XCUITest driver and iOS internals
+* [@dor-bl](https://github.com/Dor-bl) - DotNet client
+* [@eglitise](https://github.com/eglitise) - Appium server, Inspector
+* [@jlipps](https://github.com/jlipps) - Appium server, Inspector
+* [@kazucocoa](https://github.com/KazuCocoa) - all Appium projects
+* [@laolubenson](https://github.com/laolubenson) - DotNet client
+* [@mwakizaka](https://github.com/mwakizaka) - XCUITest driver
+* [@mykola-mokhnach](https://github.com/mykola-mokhnach) - all Appium projects
+* [@rerorero](https://github.com/rerorero) - XCUITest/UIA2 driver
+* [@saikrishna321](https://github.com/saikrishna321) - Java client
+* [@srinivasantarget](https://github.com/SrinivasanTarget) - Java client
+* [@tomriddly](https://github.com/tomriddly) - appium-ios-device
+* [@valfirst](https://github.com/valfirst) - Java client
+
+See [Emeritus Contributors](#emeritus-contributors) below for a list of people who formerly made
+significant contributions to the project but are no longer actively committing.
+
+### Other Contributors
+
+Other, less formal, kinds of contribution are outlined in our [Contributing Guide](https://appium.io/docs/en/latest/contributing/).
+We also very much appreciate those who spend their valuable time assisting with the [Appium forums](https://discuss.appium.io).
+Current high-level forum contributors and mods include:
+
+* [aleksei](https://discuss.appium.io/u/aleksei/summary)
+* [wreed](https://discuss.appium.io/u/wreed/summary)
+
+### Sponsorship
+
+The Appium project welcomes the sponsorship of individuals and organizations. There are two types
+of sponsorship: those related to contributions of Appium maintenance and leadership, and those
+related to contributions of funds. Both are extremely important to the ongoing health of the
+project. Financial sponsorship is mediated through our [OpenCollective page](https://opencollective.com/appium).
+Sponsorship tiers and benefits are described below:
+
+- **Development Partners**: The primary need of any open source project is for sustained maintenance and contributorship. Companies that officially sponsor such development with dedicated employee time are recognized as Development Partners, and receive the same benefits as the highest tier of financial sponsorship. To be considered a Development Partner, a company must devote at least 50% of a full-time employee's time to Appium maintenance. This means that the contributors designated by the company must have been appointed as "committers" in good standing of one or more core Appium repositories. (See above for a description of how to become a committer).
+- **Strategic Partners**: Representing the highest tier of ongoing financial support for the project, Strategic Partners are what make our compensation scheme for contributors possible, and we thank them for their significant investment into the project! More than financial contribution, Strategic Partners help elevate Appium's position in the industry through marketing and evangelism efforts, and partner with the Appium team to help make Appium better. Along with the Development Partners, Strategic Partners have their logos displayed prominently on our website, and have the ability to link to their Appium-related products in a few relevant places in our documentation.
+- **Gold, Silver, and Bronze Sponsors**: these sponsorship levels correspond to different amounts of recurring financial contribution that generously support our contributor compensation scheme. Sponsors at these levels also have the opportunity to display their logo on our website.
+- **Backers**: individuals who benefit from the Appium project can also donate on a one-time or recurring basis, at any amount, and will be recognized as Backers for their contribution!
+
+To become a sponsor at one of these levels, follow the process indicated at the [OpenCollective
+page](https://opencollective.com/appium).
+
+### Compensation Scheme
+
+With funds received through sponsorship, the Appium project wants to incentivize contributions of
+code, documentation efforts, maintenance, and project leadership. We have developed a scheme
+(inspired by one developed at the [WebdriverIO](https://github.com/webdriverio/webdriverio)
+project) for disbursing funds on a monthly basis to those who contribute to the project, as well as
+some other "upstream" open source projects.
+
+Each month, 15% of sponsorship funds received will be donated to upstream projects, based on the
+discretion of the current TC. At this point, no attempt will be made to formalize quantitative
+notions of relevance. If you manage a project upstream of Appium and would like to be considered as
+part of this donation group, give us a shout!
+
+Of the remaining 85% of sponsorship funds, 70% (roughly 60% of the original total) will go to
+project Committers (i.e., those in a role of maintenance), and 30% (roughly 25% of the original
+total) will go to Contributors (i.e., those making one-off or periodic contributions). The way that
+Committers and Contributors are paid for their efforts differs.
+
+For Committers, each Committer will keep a monthly time sheet of hours contributed to the project.
+At the end of each month, the hours tracked from all Committers will be totalled, and then the
+Committer-allocated funds will be disbursed (via OpenCollective) on a pro rata basis. Within this
+scheme, Committers agree not to submit hours worked as part of their employment with a Development
+Partner (since this is part of the "sponsorship" contribution of the Development Partner).
+
+For Contributors, when they make contributions which are successfully merged into the project,
+a Committer can discretionarily assign a "value tier" to the contribution. The "value tiers" and
+corresponding payouts are as follows:
+
+- XS: a trivial change (e.g. a typo change or applying of an automatically suggested security
+patch). \$0.
+- S: a small but useful change. \$25.
+- M: a medium-small or slightly more complex change. \$50.
+- L: a very valuable or sizable change. \$100.
+- XL: a massive change or set of changes. \$500.
+
+At the end of each month, Committers will total up the number of changes receiving potential
+payout. If the total amount of funds allocated for Contributor payout exceeds the total amount to
+be paid, then each Contributor will receive an OpenCollective link to claim their funds. If not
+enough funds exist to cover all payouts, then the payout amounts will be scaled down in a pro rata
+fashion.
+
+The scope for Committer or Contributor payouts is work completed within any "core" Appium
+repository (i.e., those officially maintained by the Appium team, residing within the Appium
+organization on GitHub, under `https://github.com/appium`).
+
+Some disclaimers: Payments will happen exclusively via OpenCollective. Recipients of funds are
+responsible for maintaining their OpenCollective account in a fashion where funds can be disbursed,
+and are responsible for any and all tax, financial, or legal consequences of receiving money in
+this way. Receipt of funds from this scheme holds the Appium project and the OpenJS Foundation free
+of any claim or obligation. While this document exists to clearly and publicly lay out the terms
+under which payments are generally made, the TC retains the right to grant or withhold funding on
+a discretionary of special basis. Basically, this scheme is run at the project's discretion, and is
+not a public service. Making contributions to the project under this scheme does not obligate the
+project to pay you for such work, or otherwise compensate you in any way.
+
+### Raising Issues Related to Governance
+
+This governance model necessarily leaves many situations unspecified. If
+questions arise as to how a given situation should proceed according to the
+overall goals of the project, the best thing to do is to open a GitHub issue
+and ping the TC members.
+
+### Emeritus Contributors
+
+* [@aluedeke](https://github.com/aluedeke)
+* [@astro03](https://github.com/Astro03)
+* [@bayandin](https://github.com/bayandin)
+* [@boneskull](https://github.com/boneskull)
+* [@bootstraponline](https://github.com/bootstraponline)
+* [@dandoveralba](https://github.com/dandoveralba)
+* [@ddkjin](https://github.com/ddkjin)
+* [@drpy](https://github.com/drpy)
+* [@dylanLacey](https://github.com/DylanLacey)
+* [@filmaj](https://github.com/filmaj)
+* [@gempesaw](https://github.com/gempesaw)
+* [@hugs](https://github.com/hugs)
+* [@imurchie](https://github.com/imurchie)
+* [@jamieEdge](https://github.com/JamieEdge)
+* [@jdeff](https://github.com/jdeff)
+* [@jonahss](https://github.com/Jonahss)
+* [@maudineormsby](https://github.com/maudineormsby)
+* [@moizjv](https://github.com/moizjv)
+* [@peepa](https://github.com/peepa)
+* [@penguinho](https://github.com/penguinho)
+* [@sbonebrake](https://github.com/sbonebrake)
+* [@scottdixon](https://github.com/scottdixon)
+* [@sebv](https://github.com/sebv)
+* [@sravanmedarapu](https://github.com/sravanmedarapu)
+* [@stuartbrussell-intuit](https://github.com/stuartbrussell-intuit)
+* [@tikhomirovSergey](https://github.com/TikhomirovSergey)
+* [@titusfortner](https://github.com/titusfortner)
+* [@vgrigoruk](https://github.com/vgrigoruk)
+* [@vmaxim](https://github.com/vmaxim)

package/src/resources/submodules/appium/IDEAS.md

@@ -0,0 +1,16 @@
+Google Summer of Code Ideas
+=====
+
+Appium is excited to participate as a [Google Summer of Code](https://summerofcode.withgoogle.com/) sponsor project. Here's a fun list of ideas that a Summer of Code student participant can use as a foundation for thinking about what to contribute to Appium!
+
+|Idea|Description|
+|----|-----------|
+|Apple tvOS Support|Our users have been asking for an Appium driver for Apple tvOS apps. Is this possible? We're not entirely sure! Why not be awesome and build it?|
+|Test App revamp|Appium uses a number of poorly-designed mobile applications in its own testing. We have to use a variety of apps because we need to test that Appium can automate all the various controls and platform features that mobile vendors provide. Really what we need is one cross-platform app (or one app per platform) that exhibit all and only the features we need to test. This would be a fun project to build some mobile apps used for testing and also demoing Appium at events and in training videos, etc...|
+|Tooling and Performance|We haven't instrumented Appium with very many performance metrics, and don't really know if we're missing some low-hanging fruit in terms of performance. Maybe you can help us do that?|
+|Babel|We have a lot of repos, and they're all on a really old version of Babel. They all need to stay in sync. How can we make this situation better, and upgrade to the latest and greatest?|
+|Unity3d Driver|Historically, Appium hasn't been great at automating games. We don't have any particular support for the frameworks used to create games. Unity is a popular one, for example. What if we could write an Appium driver that talked to an embedded process in a test version of a Unity game, that allowed us to find and interact with 3d elements? It would be amazing! You can also be amazing and lead Appium into this new world.|
+|Testing the Internet of Things|Appium's architecture makes it dead simple to integrate drivers for automating new technologies. What about _really_ new technologies like IoT devices? Help to redefine the semantics of the WebDriver protocol for use with IoT, and build a driver for an IoT device to prove it out.|
+|Driver for X|Have an idea of something else Appium could automate that it doesn't already? Build a driver for it! This would involve some awesome Node.js code, plus whatever else is needed to integrate with the platform you have in mind.|
+
+Hopefully this gives you some ideas of fun projects that would be substantial and long-lasting contributions to the Appium community.

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

@@ -0,0 +1,221 @@
+<p align="center">
+   <a href="https://appium.io/">
+      <img alt="Appium" src="https://raw.githubusercontent.com/appium/appium/master/packages/appium/docs/overrides/assets/images/appium-logo-horiz.png" width="500">
+   </a>
+</p>
+<p align="center">
+   Cross-platform test automation for native, hybrid, mobile web and desktop apps.
+</p>
+
+<div align="center">
+
+[![NPM version](https://badge.fury.io/js/appium.svg)](https://npmjs.org/package/appium)
+[![Monthly Downloads](https://img.shields.io/npm/dm/appium.svg)](https://npmjs.org/package/appium)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium?ref=badge_shield)
+[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/)
+[![CeasefireInGaza](https://img.shields.io/badge/Ceasefire_Now-%F0%9F%87%B5%F0%9F%87%B8-red?style=flat)](https://www.unrwa.org/)
+
+</div>
+
+***
+
+<p align="center"><b>
+   <a href="https://appium.io">Documentation</a> |
+   <a href="https://appium.io/docs/en/latest/intro/">Get Started</a> |
+   <a href="https://appium.io/docs/en/latest/ecosystem/">Ecosystem</a> |
+   <a href="https://github.com/appium/appium/blob/master/packages/appium/CHANGELOG.md">Changelog</a> |
+   <a href="https://appium.io/docs/en/latest/contributing/">Contributing Guide</a> |
+   <a href="https://discuss.appium.io">Discussion Forum</a>
+</b></p>
+
+***
+
+Appium is an open-source automation framework that provides
+[WebDriver](https://www.w3.org/TR/webdriver/)-based automation possibilities for a wide range of
+different mobile, desktop and IoT platforms. Appium is modular and extensible, and supports multiple
+programming languages, which means there is an entire ecosystem of related software:
+* [__Drivers__](#drivers) add support for automating specific platforms
+* [__Clients__](#clients) allow writing Appium tests in your programming language of choice
+* [__Plugins__](#plugins) allow to further extend Appium functionality
+
+## Upgrading From Older Versions
+
+The Appium team only provides support for the most recent version of Appium. If you wish to upgrade from
+an older major Appium version, please refer to the migration guides:
+
+* [Appium v2 to v3](https://appium.io/docs/en/latest/guides/migrating-2-to-3/)
+* [Appium v1 to v2](https://appium.io/docs/en/latest/guides/migrating-1-to-2/)
+
+## Installation
+
+Appium can be installed using `npm` (other package managers are not currently supported). Please
+check the [installation docs](http://appium.io/docs/en/latest/quickstart/install/) for the
+system requirements and further information.
+
+If upgrading from Appium 1, make sure Appium 1 is fully uninstalled (`npm uninstall -g appium`).
+Unexpected errors might appear if this has not been done.
+
+```bash
+npm i -g appium
+```
+
+Note that this will only install the core Appium server, which cannot automate anything on its own.
+Please install [drivers](#drivers) for your target platforms in order to automate them.
+
+## Drivers
+
+Appium supports app automation across a variety of platforms, like iOS, Android, macOS, Windows,
+and more. Each platform is supported by one or more "drivers", which know how to automate that
+particular platform. You can find a full list of officially-supported and third-party drivers in
+[Appium Ecosystem's Drivers page](http://appium.io/docs/en/latest/ecosystem/drivers/).
+
+Driver management is done using [Appium's Extension command-line interface](http://appium.io/docs/en/latest/cli/extensions/):
+
+```bash
+# Install an official driver from npm (see documentation for a list of such drivers)
+appium driver install <driver-name>
+# Install any driver from npm
+appium driver install --source=npm <driver-name>
+# See documentation for installation from other sources
+
+# List already installed drivers
+appium driver list --installed
+# Update a driver (it must be already installed)
+# This will NOT update the major version, in order to prevent breaking changes
+appium driver update <driver-name>
+# Update a driver to the most recent version (may include breaking changes)
+appium driver update <driver-name> --unsafe
+# Uninstall a driver (it won't last forever, will it?)
+appium driver uninstall <driver-name>
+```
+
+## Clients
+
+Client libraries enable writing Appium tests in different programming languages. There are
+officially-supported clients for Java, Python, Ruby, and .NET C#, as well as third-party clients
+for other languages. You can find a full list of clients in
+[Appium Ecosystem's Clients page](http://appium.io/docs/en/latest/ecosystem/clients/).
+
+## Plugins
+
+Plugins allow you to extend server functionality without changing the server code. The main
+difference between drivers and plugins is that the latter must be explicitly enabled on
+Appium server startup (all installed drivers are enabled by default):
+
+```bash
+appium --use-plugins=<plugin-name>
+```
+
+You can find a full list of officially-supported and third-party plugins in
+[Appium Ecosystem's Plugins page](http://appium.io/docs/en/latest/ecosystem/plugins/).
+
+Similarly to drivers, plugin management is also done using
+[Appium's Extension command-line interface](http://appium.io/docs/en/latest/cli/extensions/):
+
+```bash
+# Install an official plugin from npm (see documentation for a list of such plugins)
+appium plugin install <plugin-name>
+# Install any plugin from npm
+appium plugin install --source=npm <plugin-name>
+# See documentation for installation from other sources
+
+# List already installed plugins
+appium plugin list --installed
+# Update a plugin (it must be already installed)
+# This will NOT update the major version, in order to prevent breaking changes
+appium plugin update <plugin-name>
+# Update a plugin to the most recent version (may include breaking changes)
+appium plugin update <plugin-name> --unsafe
+# Uninstall a plugin
+appium plugin uninstall <plugin-name>
+```
+
+## Server Command Line Interface
+
+In order to start sending commands to the Appium server, it must be running on the URL and port
+where your client library expects it to listen. [Appium's command-line interface](http://appium.io/docs/en/latest/cli/server/)
+is used to launch and configure the server:
+
+```bash
+# Start the server on the default host (0.0.0.0) and port (4723)
+appium server
+# You can also omit the 'server' subcommand
+appium
+# Start the server on the given host, port and use a custom base path prefix (the default prefix is '/')
+appium --address 127.0.0.1 --port 9000 --base-path /wd/hub
+```
+
+Appium supports execution of parallel server processes, as well as parallel driver sessions within a
+single server process. Refer the corresponding driver documentations regarding which mode is optimal
+for the particular driver or whether it supports parallel sessions.
+
+## Why Appium?
+
+1. You usually don't have to recompile your app or modify it in any way, due to the use of standard
+   automation APIs on all platforms.
+2. You can write tests with your favorite dev tools using any WebDriver-compatible language such as
+   Java, Python, Ruby and C#. There are also third party client implementations for other languages.
+3. You can use any testing framework.
+4. Some drivers like `xcuitest` and `uiautomator2` have built-in mobile web and hybrid app support.
+   Within the same script, you can switch seamlessly between native app automation and webview
+   automation, all using the WebDriver model that's already the standard for web automation.
+5. You can run your automated tests locally and in a cloud. There are multiple cloud providers that
+   support various Appium drivers (mostly targeting iOS and Android mobile automation).
+6. [Appium Inspector](https://github.com/appium/appium-inspector) can be used to visually inspect
+   the page source of applications across different platforms, facilitating easier test development.
+
+Investing in the [WebDriver](https://w3c.github.io/webdriver/webdriver-spec.html) protocol means you
+are betting on a single, free, and open protocol for testing that has become a web standard. Don't
+lock yourself into a proprietary stack.
+
+For example, if you use Apple's XCUITest library without Appium, you can only write tests using
+Obj-C/Swift, and you can only run tests through Xcode. Similarly, with Google's UiAutomator or
+Espresso, you can only write tests in Java/Kotlin. Appium opens up the possibility of true
+cross-platform native app automation, for mobile and beyond!
+
+If you are looking for a more comprehensive description of what this is all about, please read our
+documentation on [How Does Appium Work?](https://appium.io/docs/en/latest/intro/appium/).
+
+## Sponsors
+
+Appium has a [Sponsorship Program](GOVERNANCE.md#sponsorship)! If you or your company uses Appium
+and wants to give back financially to the project, we use these funds to [encourage development and
+contributions](GOVERNANCE.md#compensation-scheme), as well as support other open source projects we
+rely on. [Become a sponsor](https://opencollective.com/appium) via our OpenCollective page.
+
+### Development and Strategic Partners
+
+Appium is incredibly grateful to our Development and Strategic Partners for their sustained
+contribution of project development and leadership!
+
+<p align="center">
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <picture>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" media="(prefers-color-scheme: dark)"/>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png" media="(prefers-color-scheme: light)"/>
+      <img src="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" width="300" alt="Browserstack"/>
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://lambdatest.com/?utm_source=appium.io&utm_medium=organic&utm_campaign=june_25&utm_term=sk&utm_content=webpage">
+    <picture>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-dark.png" media="(prefers-color-scheme: dark)"/>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-light.png" media="(prefers-color-scheme: light)"/>
+      <img src="packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-dark.png" width="300" alt="LambdaTest"/>
+    </picture>
+  </a>
+</p>
+
+### Other Sponsors
+
+A full list of sponsors is available at our [Sponsors page](https://appium.io/docs/en/latest/sponsors/).
+
+## License
+
+[Apache-2.0](./LICENSE)
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium?ref=badge_large)
+
+`@appium/logger` package is under [ISC](./packages/logger/LICENSE) License.