@ekrooh/bare 0.1.0

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 [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

@@ -0,0 +1,228 @@
+# @ekrooh/bare
+
+**One soul, many platforms.** A single codebase and identity that lives
+across every platform at once — the same app, state, and soul on Android, iOS,
+web, and desktop.
+
+[![CI](https://github.com/AndersCan/ekrooh/actions/workflows/test.yml/badge.svg)](https://github.com/AndersCan/ekrooh/actions/workflows/test.yml)
+
+The **boring bootstrap** for cross-platform apps on the Bare runtime
+(holepunch): a binary wire protocol, plugin kernel, RPC messenger, transports,
+and native host bridges — plus a reference app that demonstrates all of it.
+
+> Read `vision.md` for what this project is and is not, `AGENTS.md` for how to
+> develop it, `CONTRIBUTING.md` for how to contribute, and `RELEASING.md` for
+> how to cut a release.
+
+## The model (UI perspective)
+
+The **frontend** (browser or WebView) is written as if there is only a
+**backend** reachable over a **WebSocket** (binary framed messages). It picks a
+transport automatically:
+
+- **WebSocket** everywhere on-device: the worklet runs **one loopback HTTP+WS
+  server** that serves the web app, the media files, and the protocol socket,
+  so the page connects to the same origin it was served from (`ws://location.host`).
+- **Mock transport** when `VITE_TRANSPORT_MODE=mock` (tests).
+- Browser dev points the WebSocket at the dev backend explicitly
+  (`VITE_BARE_WS_URL`).
+
+The UI does **not** branch on worklets, Bare, or host IPC. Shared types and
+helpers (`@ekrooh/bare/core`) describe the **wire protocol** to the backend, not
+the runtime that implements it.
+
+## Glossary
+
+| Term         | Meaning                                                                                      |
+| ------------ | -------------------------------------------------------------------------------------------- |
+| **Frontend** | Web UI: Vite bundle in the browser; same bundle in the Android/iOS WebView.                  |
+| **Backend**  | Logic that runs the core bundle and speaks the framed message protocol with the frontend.    |
+| **Host**     | Native shell (Android/iOS): starts the backend, owns system APIs, injects the session token. |
+
+## Repository structure
+
+- `core/` — framework: wire protocol codec, plugin router, RPC messenger, host
+  IPC (`core/messages`), the unified loopback server (HTTP + WS + cookie auth),
+  Bare worklet entry.
+- `plugins/` — framework: canonical plugins (`core.health`, `core.discovery`,
+  `core.permissions`, `vendor.media`) and typed event builders.
+- `web/transports/` — framework: `MessageTransport` plus WebSocket and mock
+  transports.
+- `android/` — framework: Android host **library** (`:bare-host`) — IPC
+  coordinator, host plugin registry, WebView client.
+- `ios/` — framework: iOS host **Swift package** (`BareHost`) — IPC
+  coordinator, host plugin registry.
+- `examples/` — reference app: `web/` (lit-html + nanostores + Tailwind UI),
+  `android-app/` (the Android shell that embeds the backend and WebView), and
+  `ios-app/` (the iOS shell).
+- `e2e/` — Playwright tests against the browser runtime on the mock transport.
+- `scripts/` — dev backend runner, Playwright browser wrapper, prebuilds
+  fetcher, loopback smoke test.
+- `prebuilds/` — Bare Kit prebuilds (build output, gitignored).
+
+The framework's public surface is the `exports` map of the root `package.json`
+(`@ekrooh/bare/core`, `/runtime`, `/plugins`, `/plugins/*/events`, `/transports`).
+The package ships **compiled ESM JavaScript + type declarations** (`dist/`,
+built with `vp pack`) — consumers never see TypeScript source.
+
+## Support matrix
+
+| Runtime        | Status                         | Transport | Notes                                                                                                                                                           |
+| -------------- | ------------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Browser (dev)  | first-class                    | WebSocket | Vite + local backend server (`VITE_BARE_WS_URL`)                                                                                                                |
+| Browser (test) | first-class                    | Mock      | Deterministic Playwright runs                                                                                                                                   |
+| Android        | first-class                    | WebSocket | Same-origin loopback socket; cookie auth via the injected token                                                                                                 |
+| iOS            | first-class (reference parity) | WebSocket | Same-origin loopback socket + cookie auth; host ships as source (`ios/`, SPM) on the same release tag; native picker/camera + Maestro journeys land before beta |
+| Desktop        | contract                       | —         | Adapters follow the same plugin contracts                                                                                                                       |
+
+### Parity policy
+
+- Core protocol and plugin contracts are runtime-agnostic.
+- Capabilities are opt-in plugins and may be runtime-specific.
+- Plugins report unsupported behavior with deterministic errors.
+- Feature code calls plugin events, not raw platform APIs from shared UI code.
+
+## Architecture
+
+```mermaid
+flowchart LR
+  subgraph frontend [Frontend]
+    webUi[WebUI]
+  end
+  subgraph backend [Backend]
+    coreProtocol[Message protocol]
+    coreRuntime[Core + plugins]
+  end
+  subgraph host [Host native]
+    hostIpc[Host IPC]
+  end
+  webUi -->|WebSocket framed messages| coreProtocol
+  coreProtocol --> coreRuntime
+  coreRuntime <-->|delegation| hostIpc
+```
+
+## Message protocol
+
+Binary frame:
+
+- `version` (1 byte)
+- `type` (1 byte)
+- `headerLen` (2 bytes, big-endian)
+- `header` (UTF-8 JSON)
+- `payload` (optional)
+
+Implementation: `MessageProtocol` in `core/messages` (see `wire-codec.ts`).
+
+## Plugin-first architecture
+
+Core does not ship product features (camera, permissions, BLE, etc.). Teams
+add plugins with namespaced events and per-runtime handlers.
+
+- Plugin IDs: `vendor.plugin`; events are plugin-local (`health.ping`).
+- Header types: `DISPATCH`, `INVOKE_REQUEST`, `INVOKE_RESPONSE`; invoke
+  responses echo `requestId`.
+- `dispatch` is fire-and-forget; `invoke` is request/response and timeout-bound.
+- Runtime adapters: `web`, `android`, `ios`, `bare`.
+- Canonical plugins: `core.health`, `core.discovery`, `core.permissions`, and
+  `vendor.media` (reference for out-of-band binary transfer).
+
+### Loopback server + cookie auth
+
+One loopback HTTP+WS server (`core/server/static-file-server.ts`) serves the
+web app at `/`, the media files mounted by plugins, and the framed-protocol
+WebSocket socket. On device it binds `127.0.0.1` on an ephemeral port and every
+request is gated by a per-session token:
+
+- The shell injects `window.__ekrooh = { token }` (plus `window.BareShell` as
+  a presence marker) before the page loads.
+- The page exchanges it for a `bare_session` cookie via `POST /login`
+  (`HttpOnly; SameSite=Lax; Path=/`).
+- The cookie then authorizes `<img>`/`<video>`/`fetch` and the WebSocket
+  upgrade. `X-Bare-Token`/`?token=` remain as a fallback for non-browser
+  clients.
+- The worklet writes `{ origin, port, token }` to `handoff.json` in the
+  sandbox dir the host passed via `Worklet.Configuration.assets`; the host
+  reads it, injects the token, and loads `http://127.0.0.1:<port>/index.html`.
+
+The dev backend runs the same bundle with auth off on a fixed port
+(`ws://localhost:8080`), so browser dev needs no token.
+
+### Media (out-of-band bytes)
+
+Images/videos never cross the wire protocol (the frame cap is 16 MiB).
+`vendor.media` demonstrates the intended pattern: the host picks/captures a
+file natively and returns its path; the worklet mounts it on the loopback
+server and returns a URL. The web layer loads the URL directly (same-origin,
+cookie-authenticated) — one serving implementation for every runtime. The
+Android reference host wires a real native picker/camera; the iOS reference
+host's real picker/camera is part of the iOS parity worklist.
+
+## Scripts
+
+| Script                       | Purpose                                                |
+| ---------------------------- | ------------------------------------------------------ |
+| `npm run check`              | Format + lint + type-check (`vp check`)                |
+| `npm run typecheck`          | `tsc --noEmit` only                                    |
+| `npm run test`               | Unit tests + Playwright e2e                            |
+| `npm run test:unit`          | Unit tests (vitest)                                    |
+| `npm run test:e2e:web`       | Playwright e2e                                         |
+| `npm run dev`                | Vite dev server + Bare backend (watch restart)         |
+| `npm run dev:mock`           | Vite with mock transport                               |
+| `npm run dev:ws`             | Vite only (backend started separately)                 |
+| `npm run build`              | Core bundle + web assets for the Android app           |
+| `npm run build:core`         | Bundle `core/main.core.ts` with esbuild                |
+| `npm run build:web`          | Build `examples/web` into the Android app's assets     |
+| `npm run build:ios`          | iOS app inputs (addons, bundle, web assets) + xcodegen |
+| `npm run prebuilds`          | Fetch Bare Kit prebuilds (requires `gh`)               |
+| `npm run test:ios`           | XCTest + UI test on the iOS simulator                  |
+| `npm run playwright:install` | Download Chromium into `.playwright-browsers/`         |
+| `npm run smoke:loopback`     | Smoke-test the unified loopback server under `bare`    |
+
+## Testing
+
+- **Unit** — vitest (`vp test`) for the protocol codec, plugin router, RPC
+  messenger, and transports; JUnit for the Kotlin host; XCTest for the Swift
+  host.
+- **Type check** — `tsc --noEmit` (part of `vp check`).
+- **Integration** — Playwright e2e against the mock transport exercising the
+  real binary protocol (`npm run test:e2e:web`). Browsers resolve through
+  `scripts/playwright-local-browsers.mjs`, which pins `PLAYWRIGHT_BROWSERS_PATH`
+  to the repo-local `.playwright-browsers/`.
+- **Native end-to-end** — `npm run test:ios` runs the Swift host's XCTest suite
+  plus a UI test against the reference app on the iOS simulator (discovery
+  summary, Ping / Payload Echo / Roundtrip / Storage permission).
+
+## Android build
+
+Prerequisites: Android SDK (`local.properties` with `sdk.dir=...`) and Bare Kit
+prebuilds.
+
+```bash
+npm ci
+npm run prebuilds   # fetches prebuilds into prebuilds/ (gitignored)
+npm run build       # core bundle + web assets
+./gradlew :examples:android-app:assembleDebug
+```
+
+`./gradlew build` additionally runs the host library's JUnit tests.
+
+## iOS build
+
+Prerequisites: Xcode (macOS), Bare Kit prebuilds, and `xcodegen`.
+
+```bash
+npm ci
+npm run prebuilds   # fetches prebuilds/ios/BareKit.xcframework too
+npm run build:ios   # addons/, Resources/, and ios-app.xcodeproj
+npm run test:ios    # xcodebuild test on the simulator
+```
+
+`npm run test:ios` runs the Swift host's XCTest suite (hosted by the reference
+app) plus a UI test that verifies the health-checks page end to end.
+
+## Asset hygiene
+
+- Vite cleans hashed `examples/android-app/src/main/assets/assets/main-*.{js,css}`
+  before rebuilding web assets.
+- Treat files under `examples/android-app/src/main/assets/` as build output,
+  not source.