@taqwright/taqwright 0.0.24

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The taqwright contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,108 @@
+<h1 align="center">
+  <img src="src/images/taqwright_logo.png" alt="Taqwright logo" width="120" />
+  <br />
+  Taqwright
+</h1>
+
+<p align="center">
+  <a href="https://github.com/taqelah/taqwright/tags"><img src="https://img.shields.io/badge/version-0.0.24-blue" alt="version" /></a>
+</p>
+
+E2E mobile UI testing on the Playwright runner, with a flat locator API on top of Appium 3.
+
+```ts
+import { test, expect } from '@taqwright/taqwright';
+
+test('User can login', async ({ mobile }) => {
+  await mobile.getByLabel('Username').fill('admin');
+  await mobile.getByLabel('Password').fill('password');
+  await mobile.getByText('Login').click();
+  await expect(mobile.getByText('Welcome')).toBeVisible();
+});
+```
+
+> 📚 **Full documentation: [taqwright.dev/docs](https://www.taqwright.dev/docs/category/getting-started)** — install taqwright, write and generate tests, run and debug them, and scale out in parallel.
+
+## Requirements
+
+- Node.js **24.x or 25.x** (Node 26+ has a known bug).
+- A booted Android emulator, iOS simulator, or connected device.
+- [Appium 3.x](https://appium.io) (`npm i -g appium@^3`) running on `localhost:4723`, with the relevant driver installed:
+  - Android: `appium driver install uiautomator2`
+  - iOS: `appium driver install xcuitest`
+- Platform tools on `PATH`: `adb` (Android), `xcrun` (iOS, macOS only), `java` (UiAutomator2).
+
+## Install
+
+taqwright is published on npm:
+
+```bash
+npm install --save-dev @taqwright/taqwright
+```
+
+In `package.json` it looks like:
+
+```json
+"devDependencies": {
+  "@taqwright/taqwright": "^0.0.24"
+}
+```
+
+The package imports as `@taqwright/taqwright` and the CLI command is `taqwright`.
+
+## Quick start
+
+```bash
+npx taqwright init               # interactive scaffolder — creates package.json, tsconfig, sample test
+npx taqwright doctor             # verify your env (adb, xcrun, java, appium)
+npx taqwright devices            # list local emulators / simulators
+npx taqwright codegen            # record a test as you tap through the app (Playwright-codegen-style)
+npx taqwright test               # run your tests
+```
+
+## Configure
+
+Create `taqwright.config.ts` at your project root:
+
+```ts
+import { defineConfig, Platform } from '@taqwright/taqwright';
+
+export default defineConfig({
+  timeout: 30_000,
+  projects: [
+    {
+      name: 'android',
+      use: {
+        platform: Platform.ANDROID,
+        device: { provider: 'emulator', name: /Pixel 10 Pro XL/ },
+        buildPath: '/abs/path/to/app.apk',
+        appBundleId: 'com.example.app',
+        resetBetweenTests: true,
+      },
+    },
+  ],
+});
+```
+
+Every `defineConfig` / `use` option is documented in the [Configuration guide](https://www.taqwright.dev/docs/configuration).
+
+## Guides
+
+| Guide                                                                       | What it covers                                                      |
+| --------------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| [Installation](https://www.taqwright.dev/docs/installation)                 | Set up a configured project ready for its first test.               |
+| [Writing tests](https://www.taqwright.dev/docs/writing-tests)               | Drive live devices and assert UI state with auto-waiting locators.  |
+| [Generating tests](https://www.taqwright.dev/docs/generating-tests)         | Record tests in a browser-based device viewer that ranks selectors. |
+| [Running & debugging](https://www.taqwright.dev/docs/running-and-debugging) | Per-action traces, full-run videos, and Playwright reporters.       |
+| [Parallel runs](https://www.taqwright.dev/docs/parallel-runs)               | Scale out with local device pools or cloud providers.               |
+| [Configuration](https://www.taqwright.dev/docs/configuration)               | Every `defineConfig` / `use` option.                                |
+
+## Acknowledgements
+
+- [**Appium**](https://appium.io) — the underlying mobile automation server taqwright drives.
+- [**Playwright**](https://playwright.dev) — test runner, reporter, fixture machinery.
+- [**AppWright**](https://github.com/empirical-run/appwright) — thanks for the inspiration.
+
+## License
+
+Apache-2.0

package/dist/auto-appium.d.ts

@@ -0,0 +1,12 @@
+import type { ChildProcess } from 'node:child_process';
+import type { TaqwrightConfig } from './types/index.js';
+export interface AutoStartTarget {
+    name: string;
+    host: string;
+    port: number;
+    basePath?: string;
+    avd?: string;
+}
+export declare function isPortOpen(host: string, port: number, timeoutMs?: number): Promise<boolean>;
+export declare function autoStartTargets(cfg: TaqwrightConfig, projectFilter?: string[]): AutoStartTarget[];
+export declare function maybeAutoStartAppium(configPath: string, projectFilter?: string[]): Promise<ChildProcess[]>;

package/dist/auto-appium.js

@@ -0,0 +1,77 @@
+import { createConnection } from 'node:net';
+import { dirname } from 'node:path';
+import { loadTaqwrightConfig } from './config.js';
+import { startAppiumServer, killAppiumOnPort } from './providers/appium.js';
+import { isCloudProvider } from './providers/index.js';
+import { bootableAvdName } from './setup/avd.js';
+export async function isPortOpen(host, port, timeoutMs = 500) {
+    return new Promise((resolve) => {
+        const sock = createConnection({ host, port });
+        const done = (ok) => {
+            sock.destroy();
+            resolve(ok);
+        };
+        sock.setTimeout(timeoutMs);
+        sock.once('connect', () => done(true));
+        sock.once('timeout', () => done(false));
+        sock.once('error', () => done(false));
+    });
+}
+async function waitForPortClosed(host, port, timeoutMs = 5000) {
+    const deadline = Date.now() + timeoutMs;
+    while (Date.now() < deadline) {
+        if (!(await isPortOpen(host, port)))
+            return;
+        await new Promise((r) => setTimeout(r, 200));
+    }
+}
+export function autoStartTargets(cfg, projectFilter = []) {
+    const filterSet = new Set(projectFilter);
+    const seen = new Set();
+    const targets = [];
+    for (const project of cfg.projects) {
+        if (filterSet.size > 0 && !filterSet.has(project.name ?? ''))
+            continue;
+        const device = project.use?.device;
+        if (isCloudProvider(device?.provider))
+            continue;
+        const hasPool = Array.isArray(device?.pool) && device.pool.length > 0;
+        if (hasPool || device?.autoDiscover === true)
+            continue;
+        const appium = project.use?.appium;
+        if (!appium?.autoStart)
+            continue;
+        const host = appium.host ?? 'localhost';
+        const port = appium.port ?? 4723;
+        const key = `${host}:${port}`;
+        if (seen.has(key))
+            continue;
+        seen.add(key);
+        const avd = project.use ? bootableAvdName(project.use) : undefined;
+        targets.push({ name: project.name ?? '', host, port, basePath: appium.path, avd });
+    }
+    return targets;
+}
+export async function maybeAutoStartAppium(configPath, projectFilter = []) {
+    const cfg = await loadTaqwrightConfig(dirname(configPath));
+    if (!cfg)
+        return [];
+    const procs = [];
+    for (const { host, port, basePath, avd } of autoStartTargets(cfg, projectFilter)) {
+        if (await isPortOpen(host, port)) {
+            const killed = await killAppiumOnPort(port);
+            if (killed) {
+                console.log(`taqwright: killed stale Appium on ${host}:${port}, restarting…`);
+                await waitForPortClosed(host, port);
+            }
+            else {
+                console.log(`taqwright: ${host}:${port} is in use by a non-Appium process; leaving it untouched.`);
+                continue;
+            }
+        }
+        console.log(`taqwright: starting Appium server on ${host}:${port}…`);
+        const proc = await startAppiumServer('unknown', { host, port, basePath }, avd);
+        procs.push(proc);
+    }
+    return procs;
+}

package/dist/bin/branding.d.ts

@@ -0,0 +1,6 @@
+export declare function brandLine(s: string): string;
+export declare class BrandingBuffer {
+    private buf;
+    push(chunk: string): string;
+    flush(): string;
+}

package/dist/bin/branding.js

@@ -0,0 +1,22 @@
+export function brandLine(s) {
+    return s.split('playwright show-report').join('taqwright show-report');
+}
+export class BrandingBuffer {
+    buf = '';
+    push(chunk) {
+        this.buf += chunk;
+        const nl = this.buf.lastIndexOf('\n');
+        if (nl === -1)
+            return '';
+        const ready = this.buf.slice(0, nl + 1);
+        this.buf = this.buf.slice(nl + 1);
+        return brandLine(ready);
+    }
+    flush() {
+        if (!this.buf)
+            return '';
+        const out = brandLine(this.buf);
+        this.buf = '';
+        return out;
+    }
+}

package/dist/bin/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};