@ulpi/browse 1.4.4 → 2.3.1

package/LICENSE

@@ -1,21 +1,191 @@
-MIT License
-
-Copyright (c) 2025 Ciprian Hacman
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025 Ciprian Hacman
+
+   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,6 +1,6 @@
 # @ulpi/browse
 
-Headless browser CLI for AI coding agents. Persistent Chromium daemon via Playwright, ~100ms per command after startup.
+Fast headless browser and native app automation CLI for AI coding agents. Persistent Chromium daemon via Playwright, ~100ms per command. Automate Android, iOS, and macOS apps through the same interface.
 
 ## Installation
 
@@ -300,7 +300,9 @@ browse record start            # Record browsing commands as you go
 browse record stop             # Stop recording
 browse record status           # Check recording status
 browse record export browse [path]      # Export as chain-compatible JSON (replay with browse chain)
-browse record export replay [path]     # Export as Chrome DevTools Recorder (Playwright/Puppeteer)
+browse record export flow [path]       # Export as YAML flow (replay with browse flow)
+browse record export replay [path]     # Export as Chrome DevTools Recorder (browser only)
+browse record export playwright [path] # Export as Playwright Test (browser only)
 browse record export replay --selectors css,aria [path]  # Filter selector types in export
 ```
 
@@ -519,6 +521,168 @@ For full process isolation (separate Chromium instances), use `BROWSE_PORT` to r
 | Multiplexing | Yes (parallel agents) | No (one agent per profile) |
 | Use case | Parallel browsing, lightweight | Real login state, heavy |
 
+## Native App Automation
+
+Automate Android, iOS, and macOS apps through the same CLI and ref workflow:
+
+### Enable Platforms
+
+```bash
+browse enable android    # Installs adb, JDK, Android SDK, emulator, system image, driver APK
+browse enable ios        # Builds iOS runner (requires Xcode)
+browse enable macos      # Builds macOS AX bridge (requires Xcode CLI tools)
+browse enable all        # Enable all platforms
+```
+
+Each `enable` command installs all dependencies and builds the native driver for that platform. Run once — everything is cached for future use.
+
+### Simulator/Emulator Lifecycle
+
+```bash
+browse sim start --platform ios --app com.apple.Preferences --visible
+browse sim start --platform android --app com.android.settings --visible
+browse sim stop --platform ios
+browse sim stop --platform android
+browse sim status --platform ios
+browse sim status --platform android
+```
+
+- `sim start` boots the simulator/emulator, launches the target app, and starts the automation driver
+- `--visible` opens the simulator/emulator window (default: headless)
+- Switching `--app` on a running simulator reconfigures the target without rebooting
+- **Auto-install**: Android `sim start` automatically installs `adb`, Java, Android SDK, system image, and emulator via Homebrew if missing
+
+### Android
+
+```bash
+browse sim start --platform android --app com.android.settings --visible
+browse --platform android --app com.android.settings snapshot -i
+browse --platform android --app com.android.settings tap @e3
+browse --platform android --app com.android.settings swipe up
+browse --platform android --app com.android.settings press back
+browse --platform android --app com.android.settings text
+browse --platform android --app com.android.settings screenshot app.png
+browse sim stop --platform android
+```
+
+Auto-installs the full toolchain on first use (adb, JDK 21, Android SDK, emulator, system image, AVD). No manual setup required.
+
+```bash
+browse doctor --platform android    # Check setup
+```
+
+### iOS
+
+```bash
+browse sim start --platform ios --app com.apple.Preferences --visible
+browse --platform ios --app com.apple.Preferences snapshot -i
+browse --platform ios --app com.apple.Preferences tap @e2
+browse --platform ios --app com.apple.Preferences swipe up
+browse --platform ios --app com.apple.Preferences press home
+browse --platform ios --app com.apple.mobilesafari snapshot -i  # Switch app
+browse sim stop --platform ios
+```
+
+Requires: Xcode. Simulator boots automatically.
+
+### macOS
+
+```bash
+browse --app "System Settings" snapshot -i
+browse --app "System Settings" tap @e5
+browse --app "System Settings" swipe up
+browse --app TextEdit type "Hello"
+browse --app TextEdit press "cmd+n"   # Modifier combos supported
+```
+
+Requires: macOS, Accessibility permission granted to the terminal.
+
+### Platform Flags
+
+| Flag | Description |
+|------|-------------|
+| `--platform android\|ios\|macos` | Target platform (default: browser) |
+| `--app <name>` | App package name (Android), bundle ID (iOS), or process name (macOS) |
+| `--device <serial>` | Device serial (Android), simulator UDID (iOS) |
+| `--visible` | Show simulator/emulator window (default: headless) |
+
+### Unified Command Surface
+
+All platforms support the same commands: `snapshot`, `text`, `tap`, `fill`, `type`, `press`, `swipe`, `screenshot`. The `@ref` workflow is identical — `snapshot -i` assigns refs, then `tap @e1`, `fill @e2 "text"`, etc. Commands requiring browser capabilities (navigation, tabs, JavaScript) are blocked with clear errors on app targets.
+
+## Workflow Commands
+
+### Flows
+
+```bash
+browse flow run.yaml                  # Execute YAML automation script
+browse flow save login-flow           # Save current recording as named flow
+browse flow run login-flow            # Execute saved flow
+browse flow list                      # List saved flows
+browse retry                          # Retry command with backoff (browser only)
+browse watch                          # Watch DOM element for changes (browser only)
+```
+
+Flows work on all platforms (browser, Android, iOS, macOS). Each flow step goes through the `executeCommand()` pipeline — capability-gated per target. Recording captures individual flow steps, not the flow wrapper.
+
+**Browser-only workflow commands:** `retry`, `watch`, `har start/stop`, `video start/stop`
+**Browser-only export formats:** `record export replay`, `record export playwright`
+
+### Assertions
+
+```bash
+browse expect "text 'Welcome'"        # Assert text exists on page
+browse expect "count .item > 3"       # Assert element count
+browse expect "url contains /dashboard" # Assert URL
+browse expect "title 'My App'"        # Assert page title
+```
+
+### SDK Mode
+
+```typescript
+import { createBrowser } from '@ulpi/browse/sdk';
+
+const browser = await createBrowser();
+await browser.goto('https://example.com');
+const text = await browser.text();
+await browser.close();
+```
+
+## Custom Extensibility
+
+Extend browse with project-local JSON/YAML configuration in `.browse/`:
+
+### Custom Audit Rules
+
+`.browse/rules/my-rules.json`:
+```json
+[
+  { "kind": "metric-threshold", "metric": "lcp", "max": 2000, "severity": "critical" },
+  { "kind": "selector-count", "selector": "img:not([alt])", "max": 0, "severity": "warning" }
+]
+```
+
+### Custom Detection Signatures
+
+`.browse/detections/my-framework.json`:
+```json
+[
+  { "name": "MyFramework", "detect": "!!window.__MY_FRAMEWORK__", "versionExpr": "window.__MY_FRAMEWORK__.version", "category": "custom" }
+]
+```
+
+### Project Config
+
+`browse.json`:
+```json
+{
+  "detectionPaths": [".browse/detections"],
+  "rulePaths": [".browse/rules"],
+  "flowPaths": [".browse/flows"],
+  "startupFlows": ["setup.yaml"]
+}
+```
+
 ## Security
 
 All security features are opt-in — existing workflows are unaffected until you explicitly enable a feature.
@@ -587,7 +751,11 @@ Create a `browse.json` file at your project root to set persistent defaults:
   "idleTimeout": 3600000,
   "viewport": "1280x720",
   "device": "iPhone 14",
-  "runtime": "playwright"
+  "runtime": "playwright",
+  "detectionPaths": [".browse/detections"],
+  "rulePaths": [".browse/rules"],
+  "flowPaths": [".browse/flows"],
+  "startupFlows": ["setup.yaml"]
 }
 ```
 
@@ -635,7 +803,7 @@ Use browse to test the login flow. Run browse --help to see available commands.
 
 ## MCP Server Mode
 
-Run browse as an [MCP](https://modelcontextprotocol.io/) server for editors that support the Model Context Protocol. All 99 CLI commands are available as MCP tools, including `perf-audit`, `detect`, `coverage`, and `initscript`.
+Run browse as an [MCP](https://modelcontextprotocol.io/) server for editors that support the Model Context Protocol. All CLI commands are available as MCP tools — browser automation, app automation, perf-audit, detect, coverage, flows, and more.
 
 ```bash
 browse --mcp
@@ -694,6 +862,7 @@ Use `--json` alongside `--mcp` for structured responses (`{success, data, comman
 |------|-------------|
 | `--session <id>` | Named session (isolates tabs, refs, cookies) |
 | `--profile <name>` | Persistent browser profile (own Chromium, full state) |
+| `--context [state\|delta\|full]` | Action context: `state` = page changes, `delta` = ARIA diff with refs, `full` = complete snapshot with refs |
 | `--json` | Wrap output as `{success, data, command}` |
 | `--content-boundaries` | Wrap page content in nonce-delimited markers |
 | `--allowed-domains <d,d>` | Block navigation/resources outside allowlist |
@@ -717,6 +886,7 @@ Use `--json` alongside `--mcp` for structured responses (`{success, data, comman
 | `BROWSE_TIMEOUT` | (none) | Override all command timeouts (ms) |
 | `BROWSE_LOCAL_DIR` | `.browse/` or `/tmp` | State/log/screenshot directory |
 | `BROWSE_JSON` | (none) | Set to `1` for JSON output mode |
+| `BROWSE_CONTEXT` | (none) | Set to `1`/`state`/`delta`/`full` for action context levels |
 | `BROWSE_CONTENT_BOUNDARIES` | (none) | Set to `1` for nonce-delimited output |
 | `BROWSE_ALLOWED_DOMAINS` | (none) | Comma-separated domain allowlist |
 | `BROWSE_MAX_OUTPUT` | (none) | Truncate output to N characters |
@@ -737,18 +907,22 @@ Use `--json` alongside `--mcp` for structured responses (`{success, data, comman
 ## Architecture
 
 ```
-browse [--session <id>] <command>
+browse [--session <id>] [--platform <p>] [--app <name>] <command>
           |
     CLI (thin HTTP client)
           |
     Persistent server (localhost, auto-started)
           |
-    SessionManager
-    ├── "default"  → BrowserContext → tabs, refs, cookies, buffers
-    ├── "agent-a"  → BrowserContext → tabs, refs, cookies, buffers
-    └── "agent-b"  → BrowserContext → tabs, refs, cookies, buffers
-          |
-    Chromium (Playwright, headless, shared)
+    SessionManager + CommandRegistry + executeCommand()
+    ├── Browser sessions:
+    │   ├── "default"  → BrowserManager → Chromium (Playwright)
+    │   ├── "agent-a"  → BrowserManager → Chromium (shared)
+    │   └── "agent-b"  → BrowserManager → Chromium (shared)
+    ├── App sessions:
+    │   ├── "app:com.example"     → AndroidAppManager → adb → device driver
+    │   ├── "app:com.example.ios" → IOSAppManager     → simctl → Simulator
+    │   └── "app:Safari"          → AppManager         → browse-ax → macOS AX
+    └── All targets implement AutomationTarget interface
 ```
 
 - **First command:** ~2s (server + Chromium startup, once)
@@ -794,4 +968,4 @@ Inspired by and originally derived from the `/browse` skill in [gstack](https://
 
 ## License
 
-MIT
+Apache-2.0