@shipvo/test 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,73 @@
+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 [yyyy] [name of copyright owner]
+
+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

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @shipvo/test
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Typed end-to-end tests for React Native apps that run in the Shipvo simulator. Open your app, tap, type, set the phone's location, camera, permissions, biometrics, payment result and network, and assert on what is on screen. Headless, so it runs in CI with no emulator and no device.
+
+```ts
+import { test, expect } from "@shipvo/test/vitest";
+
+test("location: the app asks, then reads the phone's location", async ({ phone }) => {
+  await phone.device.set({ location: { latitude: 4.0511, longitude: 9.7679 } });
+  await phone.tap("Use my location");
+  expect(phone).toSee("access this device's location");
+  await phone.tap("While using the app");
+  await phone.waitFor(/4\.05/);
+});
+```
+
+```bash
+npm i -D @shipvo/test vitest @shipvo/sim playwright
+npx shipvo sim          # the simulator, http://localhost:4545
+npx vitest run
+```
+
+## Failure-path examples
+
+Runnable versions are in [`examples/flows.ts`](examples/flows.ts). They use the Tide & Tackle labels. Change them to match your app. The checkout flows need a cart, so open the phone with one: `openApp({ seedCart: [{ product_id: "rod-surf-36", quantity: 1 }] })`. The full purchase is in [`checkout.test.ts`](../../apps/tide-and-tackle/tests/checkout.test.ts).
+
+**Permission denied**
+
+```ts
+await phone.tap(/^Open cart/);
+await phone.tap("Choose delivery and pay");
+await phone.tap("Use my location");
+await phone.tap("Deny");
+await phone.waitFor("Location permission was not granted.");
+```
+
+**Offline**
+
+```ts
+await phone.device.set({ online: false });
+await phone.waitFor("You're offline");
+```
+
+**Payment decline**
+
+```ts
+await phone.device.set({ payment: { nextResult: "decline", pin: "1234" }, biometrics: { enrolled: true, nextResult: "success" } });
+await phone.tap(/^Open cart/);
+await phone.tap("Choose delivery and pay");
+await phone.tap(/^Any day Shop pickup/);
+await phone.tap("Mobile money");
+await phone.type("Mobile money number", "677000111");
+await phone.tap("Place order");
+await phone.tap("Use fingerprint");
+await phone.type("Mobile money PIN", "1234");
+await phone.tap("Confirm payment");
+await phone.waitFor("Payment declined");
+```
+
+The tests for these flows run against a small fake simulator, not the real app. The fake follows the real screen order and button names.
+
+Works with any runner through `openApp` from `@shipvo/test`. Full guide, CI workflow and API: [Test your app in CI](https://shipvo.dev/docs/testing/).

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { openApp, Phone, Device } from "./phone.js";
+export type { DeviceSettings, DeviceProfile, OpenOptions, Notification } from "./phone.js";
+export { parseScreen, find } from "./tree.js";
+export type { Node, Target } from "./tree.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { openApp, Phone, Device } from "./phone.js";
+export { parseScreen, find } from "./tree.js";

package/dist/phone.d.ts

@@ -0,0 +1,129 @@
+import { type Node, type Target } from "./tree.js";
+type Grant = "granted" | "denied" | "undetermined";
+/** What the simulated phone has. Takes effect for the next action. */
+export type DeviceSettings = {
+    location?: {
+        latitude: number;
+        longitude: number;
+        accuracy?: number;
+    };
+    /** What is in front of the camera: a barcode or QR code, or null for nothing. */
+    camera?: {
+        barcode?: {
+            type: string;
+            data: string;
+        } | null;
+        delayMs?: number;
+    };
+    permissions?: {
+        camera?: Grant;
+        location?: Grant;
+        notifications?: Grant;
+    };
+    biometrics?: {
+        enrolled?: boolean;
+        nextResult?: "success" | "fail" | "cancel";
+    };
+    payment?: {
+        nextResult?: "approve" | "decline" | "timeout" | "insufficient_funds";
+        pin?: string;
+    };
+    online?: boolean;
+};
+export type DeviceProfile = {
+    platform?: "android" | "ios";
+    api?: number;
+};
+export type OpenOptions = {
+    /** App id (default: SHIPVO_APP, else appId from ./shipvo.json). "id@latest" or "id@r13" opens a published release. */
+    app?: string;
+    /** Simulator URL (default: PN_SIM, else http://localhost:4545). */
+    sim?: string;
+    dark?: boolean;
+    session?: string;
+    /** Test shortcut passed to the app as globalThis.__PN_SIM__.seed_cart, in whatever shape your app reads (Tide reads { product_id, quantity }). */
+    seedCart?: Record<string, unknown>[];
+    /** Applied right after opening, before the first screen is read. */
+    device?: DeviceSettings;
+};
+export type Notification = {
+    id: string;
+    title: string;
+    body: string;
+    data?: Record<string, unknown>;
+};
+type Reply = {
+    ok: boolean;
+    screen?: string | null;
+    error?: string;
+    path?: string;
+    notifications?: Notification[];
+    log?: unknown[];
+    capabilities?: unknown;
+    release?: string | number;
+};
+/** A simulated phone running your app. Every action returns once the screen has settled, and updates `screen`. */
+export declare class Phone {
+    readonly session: string;
+    private readonly sim;
+    readonly app: string;
+    readonly release: string | number;
+    /** The current screen as an accessibility tree. */
+    screen: string;
+    readonly device: Device;
+    constructor(session: string, sim: string, app: string, release: string | number);
+    /** @internal */
+    call(path: string, body: Record<string, unknown>): Promise<Reply>;
+    /** @internal */
+    act(action: string, extra?: Record<string, unknown>): Promise<Reply>;
+    /** Every element on the current screen. */
+    nodes(): Node[];
+    /** Is this text (or pattern) anywhere on the current screen? */
+    sees(text: string | RegExp): boolean;
+    /** Find one element without acting on it. Throws if none or several match. */
+    locate(target: Target): Node;
+    tap(target: Target): Promise<this>;
+    type(target: Target, text: string, opts?: {
+        enter?: boolean;
+    }): Promise<this>;
+    scroll(direction?: "down" | "up" | "left" | "right", on?: Target): Promise<this>;
+    back(): Promise<this>;
+    refresh(): Promise<this>;
+    /** Wait until the text appears (default 5 s). On timeout the error carries the last screen. */
+    waitFor(text: string | RegExp, opts?: {
+        timeout?: number;
+        interval?: number;
+    }): Promise<this>;
+    /** Wait until the text is gone. */
+    waitForGone(text: string | RegExp, opts?: {
+        timeout?: number;
+        interval?: number;
+    }): Promise<this>;
+    /** Deliver a push notification: it shows as a banner the app can be opened from. */
+    notify(n: {
+        title: string;
+        body: string;
+        data?: Record<string, unknown>;
+    }): Promise<this>;
+    /** The notification shade (banners vanish after about 5 s, the shade keeps them). */
+    notifications(): Promise<Notification[]>;
+    /** Tap a notification from the shade (the newest if no id). */
+    openNotification(id?: string): Promise<this>;
+    /** What the app did with the device: permission prompts and answers, location reads, scans, fingerprint checks, payments. */
+    deviceLog(): Promise<unknown[]>;
+    /** A PNG of the screen. Works when the test runs on the same machine as the simulator, as in CI. */
+    screenshot(): Promise<Uint8Array>;
+    /** Nothing to release on the simulator side today; kept so tests read the same if that changes. */
+    close(): Promise<void>;
+}
+/** The simulated phone's hardware and settings. */
+export declare class Device {
+    private readonly phone;
+    constructor(phone: Phone);
+    set(settings: DeviceSettings): Promise<Phone>;
+    /** Back to a known state: permissions undetermined, default location, nothing in front of the camera, log cleared. */
+    reset(profile?: DeviceProfile): Promise<Phone>;
+}
+/** Open your app in a fresh simulated phone. */
+export declare function openApp(opts?: OpenOptions): Promise<Phone>;
+export {};

package/dist/phone.js

@@ -0,0 +1,148 @@
+import { existsSync, readFileSync } from "node:fs";
+import { find, parseScreen } from "./tree.js";
+/** A simulated phone running your app. Every action returns once the screen has settled, and updates `screen`. */
+export class Phone {
+    session;
+    sim;
+    app;
+    release;
+    /** The current screen as an accessibility tree. */
+    screen = "";
+    device;
+    constructor(session, sim, app, release) {
+        this.session = session;
+        this.sim = sim;
+        this.app = app;
+        this.release = release;
+        this.device = new Device(this);
+    }
+    /** @internal */
+    async call(path, body) {
+        const r = await fetch(this.sim + path, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify(body) });
+        if (!r.ok)
+            throw new Error(`simulator ${path} answered ${r.status}. Is it running at ${this.sim}? Start it with: npx shipvo sim`);
+        return (await r.json());
+    }
+    /** @internal */
+    async act(action, extra = {}) {
+        const r = await this.call("/act", { session: this.session, action, ...extra });
+        if (typeof r.screen === "string")
+            this.screen = r.screen;
+        // A page that is still loading reads as empty: give it a moment rather than report a blank screen.
+        for (let i = 0; r.ok && action !== "screenshot" && !this.screen.trim() && i < 10; i++) {
+            await new Promise((res) => setTimeout(res, 200));
+            const again = await this.call("/act", { session: this.session, action: "screen" });
+            if (typeof again.screen === "string")
+                this.screen = again.screen;
+        }
+        if (!r.ok)
+            throw new Error(`${action} failed: ${r.error}\n\nScreen now:\n${this.screen}`);
+        return r;
+    }
+    /** Every element on the current screen. */
+    nodes() { return parseScreen(this.screen); }
+    /** Is this text (or pattern) anywhere on the current screen? */
+    sees(text) {
+        return text instanceof RegExp ? text.test(this.screen) : this.screen.toLowerCase().includes(text.toLowerCase());
+    }
+    /** Find one element without acting on it. Throws if none or several match. */
+    locate(target) {
+        try {
+            return find(this.nodes(), target);
+        }
+        catch (e) {
+            throw new Error(`${e.message}\n\nScreen now:\n${this.screen}`);
+        }
+    }
+    async tap(target) { await this.act("tap", { ref: this.locate(target).ref }); return this; }
+    async type(target, text, opts = {}) {
+        const n = find(this.nodes(), target, typeof target === "string" || target instanceof RegExp ? { roles: ["textbox", "searchbox", "spinbutton", "combobox"] } : {});
+        await this.act("type", { ref: n.ref, text, enter: opts.enter });
+        return this;
+    }
+    async scroll(direction = "down", on) {
+        await this.act("scroll", { direction, ref: on ? this.locate(on).ref : undefined });
+        return this;
+    }
+    async back() { await this.act("back"); return this; }
+    async refresh() { await this.act("screen"); return this; }
+    /** Wait until the text appears (default 5 s). On timeout the error carries the last screen. */
+    async waitFor(text, opts = {}) {
+        const end = Date.now() + (opts.timeout ?? 5000);
+        for (;;) {
+            await this.refresh();
+            if (this.sees(text))
+                return this;
+            if (Date.now() > end)
+                throw new Error(`timed out waiting for ${text instanceof RegExp ? text : `"${text}"`}\n\nScreen now:\n${this.screen}`);
+            await new Promise((r) => setTimeout(r, opts.interval ?? 250));
+        }
+    }
+    /** Wait until the text is gone. */
+    async waitForGone(text, opts = {}) {
+        const end = Date.now() + (opts.timeout ?? 5000);
+        for (;;) {
+            await this.refresh();
+            if (!this.sees(text))
+                return this;
+            if (Date.now() > end)
+                throw new Error(`"${text}" is still on screen after ${opts.timeout ?? 5000} ms\n\nScreen now:\n${this.screen}`);
+            await new Promise((r) => setTimeout(r, opts.interval ?? 250));
+        }
+    }
+    /** Deliver a push notification: it shows as a banner the app can be opened from. */
+    async notify(n) { await this.act("push_notification", n); return this; }
+    /** The notification shade (banners vanish after about 5 s, the shade keeps them). */
+    async notifications() { return (await this.act("notifications")).notifications ?? []; }
+    /** Tap a notification from the shade (the newest if no id). */
+    async openNotification(id) { await this.act("open_notification", { id }); return this; }
+    /** What the app did with the device: permission prompts and answers, location reads, scans, fingerprint checks, payments. */
+    async deviceLog() { return (await this.act("device_log")).log ?? []; }
+    /** A PNG of the screen. Works when the test runs on the same machine as the simulator, as in CI. */
+    async screenshot() {
+        const r = await this.act("screenshot");
+        if (!r.path)
+            throw new Error("the simulator returned no screenshot");
+        return new Uint8Array(readFileSync(r.path));
+    }
+    /** Nothing to release on the simulator side today; kept so tests read the same if that changes. */
+    async close() { }
+}
+/** The simulated phone's hardware and settings. */
+export class Device {
+    phone;
+    constructor(phone) {
+        this.phone = phone;
+    }
+    async set(settings) { await this.phone.act("set_device", { device: settings }); return this.phone; }
+    /** Back to a known state: permissions undetermined, default location, nothing in front of the camera, log cleared. */
+    async reset(profile = {}) { await this.phone.act("device_reset", { device: profile }); return this.phone; }
+}
+function defaultApp() {
+    if (process.env.SHIPVO_APP)
+        return process.env.SHIPVO_APP;
+    if (existsSync("shipvo.json")) {
+        try {
+            return JSON.parse(readFileSync("shipvo.json", "utf8")).appId;
+        }
+        catch { /* fall through */ }
+    }
+    throw new Error("which app? Pass { app } to openApp, set SHIPVO_APP, or run from a folder with shipvo.json");
+}
+/** Open your app in a fresh simulated phone. */
+export async function openApp(opts = {}) {
+    const sim = (opts.sim ?? process.env.PN_SIM ?? "http://localhost:4545").replace(/\/$/, "");
+    const app = opts.app ?? defaultApp();
+    const session = opts.session ?? `t-${Math.random().toString(36).slice(2, 10)}`;
+    const probe = new Phone(session, sim, app.split("@")[0], "local");
+    const r = await probe.call("/session", { session, app, seed_cart: opts.seedCart, dark: opts.dark });
+    if (!r.ok)
+        throw new Error(`could not open "${app}": ${r.error}`);
+    const phone = new Phone(session, sim, app.split("@")[0], r.release ?? "local");
+    phone.screen = r.screen ?? "";
+    if (!phone.screen.trim())
+        await phone.refresh(); // a seeded cart reloads the page: read the screen again
+    if (opts.device)
+        await phone.device.set(opts.device);
+    return phone;
+}

package/dist/tree.d.ts

@@ -0,0 +1,24 @@
+/** One line of the simulator's screen: the accessibility tree an agent sees. */
+export type Node = {
+    role: string;
+    /** Accessible name: the quoted label (buttons, links, fields, headings). */
+    name: string;
+    /** Text after the colon (plain text nodes). */
+    text: string;
+    ref: string;
+    /** Raw attribute brackets, e.g. ["level=1", "disabled"]. */
+    attrs: string[];
+    line: string;
+};
+/** Parse a screen into nodes. Lines that are not elements (url lines, blank) are skipped. */
+export declare function parseScreen(screen: string): Node[];
+/** What to act on: a visible label or text, a pattern, a role and name, or a ref from the screen. */
+export type Target = string | RegExp | {
+    role?: string;
+    name?: string | RegExp;
+    ref?: string;
+};
+/** Find one element. Exact label wins; otherwise a unique case-insensitive substring. Ambiguity is an error that lists the candidates. */
+export declare function find(nodes: Node[], target: Target, { roles }?: {
+    roles?: string[];
+}): Node;

package/dist/tree.js

@@ -0,0 +1,48 @@
+const LINE = /^\s*- ([\w-]+)(?: "((?:[^"\\]|\\.)*)")?((?: \[[^\]]*\])*)(?::\s*(.*))?$/;
+const unquote = (s) => s.replace(/\\(.)/g, "$1");
+/** Parse a screen into nodes. Lines that are not elements (url lines, blank) are skipped. */
+export function parseScreen(screen) {
+    const out = [];
+    for (const raw of screen.split("\n")) {
+        // The snapshot YAML-quotes a line when its name contains ": " or similar: - 'button "a: b" [ref=e1]':
+        const q = /^(\s*- )'(.*)'(:?)$/.exec(raw);
+        const line = q ? q[1] + q[2].replace(/''/g, "'") + q[3] : raw;
+        const m = LINE.exec(line);
+        if (!m)
+            continue;
+        const attrs = [...(m[3] ?? "").matchAll(/\[([^\]]*)\]/g)].map((x) => x[1]);
+        const ref = attrs.find((a) => /^ref=/.test(a))?.slice(4) ?? "";
+        if (!ref)
+            continue;
+        let text = (m[4] ?? "").trim();
+        if (/^".*"$/.test(text))
+            text = unquote(text.slice(1, -1));
+        out.push({ role: m[1], name: m[2] === undefined ? "" : unquote(m[2]), text, ref, attrs: attrs.filter((a) => !/^(ref|cursor)=/.test(a)), line: line.trim() });
+    }
+    return out;
+}
+const matches = (v, want, exact) => want instanceof RegExp ? want.test(v) : exact ? v === want : v.toLowerCase().includes(want.toLowerCase());
+const label = (n) => n.name || n.text;
+/** Find one element. Exact label wins; otherwise a unique case-insensitive substring. Ambiguity is an error that lists the candidates. */
+export function find(nodes, target, { roles } = {}) {
+    const pool = (list) => (roles ? list.filter((n) => roles.includes(n.role)) : list);
+    const describe = typeof target === "string" ? `"${target}"` : target instanceof RegExp ? String(target) : JSON.stringify(target);
+    let hits;
+    if (typeof target === "object" && !(target instanceof RegExp)) {
+        if (target.ref)
+            hits = nodes.filter((n) => n.ref === target.ref);
+        else
+            hits = nodes.filter((n) => (!target.role || n.role === target.role) && (target.name === undefined || matches(label(n), target.name, typeof target.name === "string")));
+    }
+    else {
+        const all = pool(nodes).filter((n) => label(n) !== "");
+        hits = all.filter((n) => matches(label(n), target, true));
+        if (hits.length === 0 && typeof target === "string")
+            hits = all.filter((n) => matches(label(n), target, false));
+    }
+    if (hits.length === 0)
+        throw new Error(`nothing on screen matches ${describe}`);
+    if (hits.length > 1)
+        throw new Error(`${hits.length} elements match ${describe}; be more specific:\n${hits.slice(0, 6).map((n) => "  " + n.line).join("\n")}`);
+    return hits[0];
+}

package/dist/vitest.d.ts

@@ -0,0 +1,20 @@
+import { expect } from "vitest";
+import { openApp, type Phone } from "./phone.js";
+interface ShipvoMatchers<R = unknown> {
+    /** The phone's current screen contains this text or pattern. */
+    toSee(text: string | RegExp): R;
+    /** There is a button with this name (exact, or a pattern) on screen. */
+    toHaveButton(name: string | RegExp): R;
+}
+declare module "vitest" {
+    interface Assertion<T = any> extends ShipvoMatchers<T> {
+    }
+    interface AsymmetricMatchersContaining extends ShipvoMatchers {
+    }
+}
+/** A fresh simulated phone per test, closed afterwards. Needs the simulator running (npx shipvo sim). */
+export declare const test: import("vitest").TestAPI<{
+    phone: Phone;
+}>;
+export { expect, openApp };
+export type { Phone };

package/dist/vitest.js

@@ -0,0 +1,21 @@
+// Vitest integration: a `phone` fixture (a fresh simulated phone per test) and screen matchers.
+//   import { test, expect } from "@shipvo/test/vitest";
+//   test("checkout", async ({ phone }) => { await phone.tap("Add to cart"); expect(phone).toSee("Cart (1)"); });
+import { expect, test as base } from "vitest";
+import { openApp } from "./phone.js";
+const show = (t) => (t instanceof RegExp ? String(t) : JSON.stringify(t));
+expect.extend({
+    toSee(phone, text) {
+        const pass = phone.sees(text);
+        return { pass, message: () => (pass ? `expected the screen not to show ${show(text)}\n\n${phone.screen}` : `expected the screen to show ${show(text)}\n\nScreen now:\n${phone.screen}`) };
+    },
+    toHaveButton(phone, name) {
+        const pass = phone.nodes().some((n) => n.role === "button" && (name instanceof RegExp ? name.test(n.name) : n.name === name));
+        return { pass, message: () => (pass ? `expected no button ${show(name)}` : `expected a button ${show(name)}\n\nScreen now:\n${phone.screen}`) };
+    },
+});
+/** A fresh simulated phone per test, closed afterwards. Needs the simulator running (npx shipvo sim). */
+export const test = base.extend({
+    phone: async ({}, use) => { const phone = await openApp(); await use(phone); await phone.close(); },
+});
+export { expect, openApp };

package/package.json

@@ -1,6 +1,56 @@
 {
   "name": "@shipvo/test",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "type": "module",
+  "license": "Apache-2.0",
+  "description": "Typed end-to-end tests for React Native apps that run in the Shipvo simulator: open the app, tap, type, set the phone's location, camera and permissions, and assert on what is on screen. Works in Vitest or any test runner, headless, in CI.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./vitest": {
+      "types": "./dist/vitest.d.ts",
+      "default": "./dist/vitest.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "vitest": ">=2"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.8.0",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "testing",
+    "e2e",
+    "simulator",
+    "vitest",
+    "ci",
+    "shipvo"
+  ],
+  "homepage": "https://shipvo.dev/docs/testing/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shipvo/shipvo.git",
+    "directory": "packages/test"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "tsc -p tsconfig.examples.json && vitest run"
+  }
 }