{"_id":"@clary-so/appium-helper","_rev":"3-a4aa0c4ce2384e920a549df947ad0f44","name":"@clary-so/appium-helper","dist-tags":{"latest":"0.5.6"},"versions":{"0.5.5":{"name":"@clary-so/appium-helper","version":"0.5.5","author":{"name":"Almouro","email":"alexandrem@bam.tech"},"license":"MIT","_id":"@clary-so/appium-helper@0.5.5","maintainers":[{"name":"linus-bolls","email":"linus.bolls@gmail.com"},{"name":"laurinnote","email":"laurin.notemann@clary.so"}],"dist":{"shasum":"63587193fa4bc89c1ef1e3a6896c4ffea961f882","tarball":"https://registry.npmjs.org/@clary-so/appium-helper/-/appium-helper-0.5.5.tgz","fileCount":18,"integrity":"sha512-34nbO01k9nEaUF6lTIDFoNOwy0to19+0DibHLdHV5xZ3hdBBOA35/xWW2QAuscT5bgSqsojOeHyvPdblb9pkfg==","signatures":[{"sig":"MEYCIQCZWUdc1PpHEbcDA/Pmn6B5UN7hAS0j4ZxAi50FZUomzgIhAJrDcLmLSy1yT6w+lAN4akNWSC7ZcI/eN9dOde5HWhNj","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":116162},"main":"dist/index.js","gitHead":"04701e8b54770af21dd476a8a48da1229061c7f2","scripts":{"test":"tsc"},"_npmUser":{"name":"linus-bolls","email":"linus.bolls@gmail.com"},"_npmVersion":"lerna/8.1.9/node@v22.19.0+arm64 (darwin)","directories":{},"_nodeVersion":"22.19.0","dependencies":{"webdriverio":"^6.1.22","@clary-so/logger":"^0.3.3"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/appium-helper_0.5.5_1775049398708_0.9931634858837917","host":"s3://npm-registry-packages-npm-production"}},"0.5.6":{"name":"@clary-so/appium-helper","version":"0.5.6","author":{"name":"Almouro","email":"alexandrem@bam.tech"},"license":"MIT","main":"dist/index.js","scripts":{"test":"tsc"},"dependencies":{"@clary-so/logger":"^0.3.4","webdriverio":"^6.1.22"},"_id":"@clary-so/appium-helper@0.5.6","gitHead":"20e2eee8a6dd2f74473df89823616c314419182a","types":"./dist/index.d.ts","description":"Appium is a blackbox e2e testing framework, which means you can run it on any app (even production ones) with no setup required.","_nodeVersion":"22.19.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-1cxWBfrymc8iJAaQgvoV0i9zEXH+rrabiowjEHGCAhVcuIi2KjdNmSTlQM5wQtolUOpLZwBbWvr2w/Qkffi8Lg==","shasum":"403cd11d18105b4afbbfa0f6c6057ac2e7836860","tarball":"https://registry.npmjs.org/@clary-so/appium-helper/-/appium-helper-0.5.6.tgz","fileCount":17,"unpackedSize":115088,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCiuN6g6p0bkHF4HCtlJDaz6ifOg9dOe7+0wZq9HeimVgIgMnbLeJLl1/Teph/QTDsk+lUMObVNzFZtDR5iYxBEi1M="}]},"_npmUser":{"name":"linus-bolls","email":"linus.bolls@gmail.com"},"directories":{},"maintainers":[{"name":"linus-bolls","email":"linus.bolls@gmail.com"},{"name":"laurinnote","email":"laurin.notemann@clary.so"},{"name":"tommyengelmann","email":"tom.engelmann@clary.so"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/appium-helper_0.5.6_1775115440987_0.8169335377322386"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-01T13:16:38.614Z","modified":"2026-04-02T07:37:21.291Z","0.5.5":"2026-04-01T13:16:38.850Z","0.5.6":"2026-04-02T07:37:21.128Z"},"author":{"name":"Almouro","email":"alexandrem@bam.tech"},"license":"MIT","maintainers":[{"name":"linus-bolls","email":"linus.bolls@gmail.com"},{"name":"laurinnote","email":"laurin.notemann@clary.so"},{"name":"tommyengelmann","email":"tom.engelmann@clary.so"}],"readme":"# Appium Helper\n\nAppium is a blackbox e2e testing framework, which means you can run it on any app (even production ones) with no setup required.\n\nHowever, since it supports many languages and platforms, the docs can be difficult to navigate and find the precise way to do things. This package wraps a `webdriverio` client to expose most common e2e testing capabilities you would want to use.\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n\n- [Usage](#usage)\n  - [Getting started](#getting-started)\n  - [API](#api)\n    - [Wait for element](#wait-for-element)\n    - [Click element](#click-element)\n    - [Scrolling](#scrolling)\n    - [Start/Stop app](#startstop-app)\n    - [Waiting](#waiting)\n    - [Inputs](#inputs)\n    - [Run any other webdriverio commands](#run-any-other-webdriverio-commands)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n## Usage\n\n### Getting started\n\n1. Install the helper `yarn add @bam.tech/appium-helper`\n\n2. Write your test script\n\n```ts\n// appium.test.ts\nimport { AppiumDriver } from \"@bam.tech/appium-helper\";\n\ntest(\"e2e\", async () => {\n  const driver = await AppiumDriver.create({\n    // `npx @perf-profiler/profiler getCurrentApp` will display info for the current app\n    appPackage: \"com.example\",\n    appActivity: \"com.example.MainActivity\",\n  });\n\n  driver.startApp();\n  await driver.findElementByText(\"Welcome\");\n});\n```\n\n3. Run the appium server `npx appium` in a terminal. If you just installed Appium, you may need to install a driver, e.g., by running `npx appium driver install uiautomator2`.\n4. Run your test file in a separate terminal `yarn jest appium.test.ts`\n\n### API\n\n#### Wait for element\n\nYou can find an element by text or `testID`. The helper will wait for the element to exist and return it:\n\n```ts\nawait driver.findElementByText(\"Welcome\");\nawait driver.findElementById(\"welcome_text\");\n```\n\n#### Click element\n\nYou can click an element by text or `testID`. The helper will wait for the element to exist and click it:\n\n```ts\nawait driver.clickElementByText(\"Welcome\");\nawait driver.clickElementById(\"welcome_text\");\n```\n\n#### Scrolling\n\n```ts\nawait driver.scrollDown();\nawait driver.scrollToEnd();\n```\n\n#### Start/Stop app\n\n```ts\ndriver.startApp();\n// You should probably add a finder to wait for the app to start\n// for instance driver.findElementByText(\"Welcome\");\n\ndriver.stopApp();\n```\n\n#### Waiting\n\nYou can also wait for a certain amount of time:\n\n```ts\nawait driver.wait(<delay in ms>);\n// e.g.\nawait driver.wait(5000);\n```\n\n#### Inputs\n\nFirst find the element by its placeholder, value or test id, then use `addValue`:\n\n```ts\nconst input = await driver.findElementByText(\"Email input Placeholder\");\nawait input.addValue(\"My username\");\n```\n\n#### Run any other webdriverio commands\n\n`AppiumDriver` just wraps a [webdriverio](https://webdriver.io/) client.\nYou can still run any `webdriverio` commands using:\n\n```ts\nconst client = driver.client;\n// run any commands\nawait client.$(\"...\");\n```\n","readmeFilename":"README.md","description":"Appium is a blackbox e2e testing framework, which means you can run it on any app (even production ones) with no setup required."}