restty 0.1.34 → 0.2.0

package/README.md

@@ -1,36 +1,20 @@
 # restty
 
 [![Version](https://img.shields.io/npm/v/restty?style=flat-square)](https://www.npmjs.com/package/restty)
-[![Downloads](https://img.shields.io/npm/dm/restty)](https://www.npmjs.com/package/restty)
-[![Package Size](https://img.shields.io/npm/unpacked-size/restty?style=flat-square)](https://www.npmjs.com/package/restty)
+[![Downloads](https://img.shields.io/npm/dm/restty?style=flat-square)](https://www.npmjs.com/package/restty)
 [![CI](https://img.shields.io/github/actions/workflow/status/wiedymi/restty/ci.yml?branch=main&style=flat-square)](https://github.com/wiedymi/restty/actions/workflows/ci.yml)
-[![Publish](https://img.shields.io/github/actions/workflow/status/wiedymi/restty/publish.yml?style=flat-square&label=publish)](https://github.com/wiedymi/restty/actions/workflows/publish.yml)
 [![Demo](https://img.shields.io/badge/demo-restty.pages.dev-0ea5e9?style=flat-square)](https://restty.pages.dev/)
 
-[![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github&logoColor=white)](https://github.com/wiedymi)
-[![Twitter](https://img.shields.io/badge/-Twitter-1DA1F2?style=flat-square&logo=twitter&logoColor=white)](https://x.com/wiedymi)
-[![Email](https://img.shields.io/badge/-Email-EA4335?style=flat-square&logo=gmail&logoColor=white)](mailto:contact@wiedymi.com)
-[![Discord](https://img.shields.io/badge/-Discord-5865F2?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/zemMZtrkSb)
-[![Support me](https://img.shields.io/badge/-Support%20me-ff69b4?style=flat-square&logo=githubsponsors&logoColor=white)](https://github.com/sponsors/vivy-company)
+Browser terminal rendering for web apps, powered by `libghostty-vt` in WASM,
+WebGPU with WebGL2 fallback, and TypeScript text shaping.
 
-Powerful, lightweight browser terminal. Batteries included.
+- Demo: <https://restty.pages.dev/>
+- Canonical docs: <https://restty.pages.dev/docs>
+- npm: <https://www.npmjs.com/package/restty>
+- Issues: <https://github.com/wiedymi/restty/issues>
 
-Live demo: `https://restty.pages.dev/`
-
-Powered by:
-
-- `libghostty-vt` (WASM terminal core)
-- `WebGPU` (with WebGL2 fallback)
-- `text-shaper` (shaping + raster)
-
-## Release Status
-
-`restty` is in an early release stage.
-
-- Known issue: kitty image protocol handling can still fail in some edge cases.
-- API note: high-level APIs are usable now, but some APIs may still change to improve DX.
-
-If you hit an issue, please open one on GitHub with repro steps.
+`restty` is early-release software. The high-level API is usable, but some APIs may still change
+while the developer experience settles.
 
 ## Install
 
@@ -54,281 +38,36 @@ const restty = new Restty({
 restty.connectPty("ws://localhost:8787/pty");
 ```
 
-That is the primary API: `new Restty(...)`.
-`restty` creates pane DOM, canvas, and hidden IME input for you.
-
-## Common Tasks
-
-### Apply a built-in theme
-
-```ts
-import { getBuiltinTheme } from "restty";
-
-const theme = getBuiltinTheme("Aizen Dark");
-if (theme) restty.applyTheme(theme);
-```
-
-### Parse and apply a Ghostty theme file
-
-```ts
-import { parseGhosttyTheme } from "restty";
-
-const theme = parseGhosttyTheme(`
-foreground = #c0caf5
-background = #1a1b26
-cursor-color = #c0caf5
-`);
-
-restty.applyTheme(theme, "inline");
-```
-
-### Split panes and operate per pane
-
-```ts
-restty.splitActivePane("vertical");
-restty.splitActivePane("horizontal");
+`new Restty(...)` creates the pane DOM, canvas, and hidden IME input for you.
 
-for (const pane of restty.panes()) {
-  pane.connectPty("ws://localhost:8787/pty");
-}
-```
+## Main Entrypoints
 
-### Use active-pane convenience methods
+- `restty`: primary API (`Restty`, `createRestty`, themes, fonts, PTY helpers, plugin types).
+- `restty/xterm`: focused xterm.js-style compatibility wrapper.
+- `restty/headless`: DOM-free WASM terminal core wrapper for replay, tests, and backend-owned sessions.
+- `restty/esm`: standalone browser ESM bundle for script/CDN usage.
+- `restty/internal`, `restty/internal/runtime`, `restty/internal/surface`: unstable advanced modules.
 
-```ts
-restty.setFontSize(15);
-restty.sendInput("ls -la\n");
-restty.copySelectionToClipboard();
-```
+See the canonical [API surface docs](https://restty.pages.dev/docs/api-surface) for the current
+method and export list.
 
-### Provide custom fonts
-
-By default, restty uses a local-first font preset with CDN fallback. To fully control fonts, disable the preset and pass `fontSources`.
-
-```ts
-const restty = new Restty({
-  root: document.getElementById("terminal") as HTMLElement,
-  appOptions: {
-    fontPreset: "none",
-  },
-  fontSources: [
-    {
-      type: "url",
-      url: "https://cdn.jsdelivr.net/gh/JetBrains/JetBrainsMono@v2.304/fonts/ttf/JetBrainsMono-Regular.ttf",
-      label: "JetBrains Mono",
-    },
-    {
-      type: "local",
-      matchers: ["jetbrains mono nerd font", "fira code nerd font"],
-      label: "Local fallback",
-    },
-  ],
-});
-```
-
-Update fonts at runtime (all panes):
-
-```ts
-await restty.setFontSources([
-  { type: "local", matchers: ["sf mono"], required: true },
-  {
-    type: "url",
-    url: "https://cdn.jsdelivr.net/gh/ryanoasis/nerd-fonts@v3.4.0/patched-fonts/NerdFontsSymbolsOnly/SymbolsNerdFontMono-Regular.ttf",
-  },
-]);
-```
-
-### Touch behavior (pan-first by default)
-
-On touch devices, restty defaults to pan-first scrolling with long-press selection.
-
-```ts
-const restty = new Restty({
-  root: document.getElementById("terminal") as HTMLElement,
-  appOptions: {
-    // "long-press" (default) | "drag" | "off"
-    touchSelectionMode: "long-press",
-    // Optional tuning knobs:
-    touchSelectionLongPressMs: 450,
-    touchSelectionMoveThresholdPx: 10,
-  },
-});
-```
-
-### Plugin system (native)
-
-Use plugins when you want to extend restty behavior without patching core.
-
-```ts
-import type { ResttyPlugin } from "restty";
+## Common Links
 
-const metricsPlugin: ResttyPlugin = {
-  id: "example/metrics",
-  apiVersion: 1,
-  activate(ctx) {
-    const paneCreated = ctx.on("pane:created", ({ paneId }) => {
-      console.log("pane created", paneId);
-    });
-    const outgoing = ctx.addInputInterceptor(({ text }) => text.replace(/\t/g, "  "));
-    const lifecycle = ctx.addLifecycleHook(({ phase, action }) => {
-      console.log("lifecycle", phase, action);
-    });
-    const stage = ctx.addRenderStage({
-      id: "metrics/tint",
-      mode: "after-main",
-      uniforms: [0.12],
-      shader: {
-        wgsl: `
-fn resttyStage(color: vec4f, uv: vec2f, time: f32, params0: vec4f, params1: vec4f) -> vec4f {
-  return vec4f(min(vec3f(1.0), color.rgb + vec3f(params0.x, 0.0, 0.0)), color.a);
-}
-`,
-      },
-    });
-    return () => {
-      paneCreated.dispose();
-      outgoing.dispose();
-      lifecycle.dispose();
-      stage.dispose();
-    };
-  },
-};
-
-await restty.use(metricsPlugin, { sampleRate: 1 });
-console.log(restty.pluginInfo("example/metrics"));
-restty.unuse("example/metrics");
-```
-
-Declarative loading (manifest + registry):
-
-```ts
-await restty.loadPlugins(
-  [{ id: "example/metrics", options: { sampleRate: 1 } }],
-  {
-    "example/metrics": () => metricsPlugin,
-  },
-);
-```
-
-See `docs/plugins.md` for full plugin authoring details.
-
-### Shader stages
-
-Shader stages let you extend the final frame pipeline with WGSL/GLSL passes.
-
-Global stages:
-
-```ts
-restty.setShaderStages([
-  {
-    id: "app/crt-lite",
-    mode: "after-main",
-    backend: "both",
-    uniforms: [0.24, 0.12],
-    shader: {
-      wgsl: `
-fn resttyStage(color: vec4f, uv: vec2f, time: f32, params0: vec4f, params1: vec4f) -> vec4f {
-  let v = clamp(params0.x, 0.0, 0.8);
-  let centered = (uv - vec2f(0.5, 0.5)) * 2.0;
-  let vignette = max(0.0, 1.0 - v * dot(centered, centered));
-  return vec4f(color.rgb * vignette, color.a);
-}
-`,
-    },
-  },
-]);
-
-const stage = restty.addShaderStage({
-  id: "app/mono",
-  mode: "after-main",
-  uniforms: [1.0],
-  shader: {
-    wgsl: `
-fn resttyStage(color: vec4f, uv: vec2f, time: f32, params0: vec4f, params1: vec4f) -> vec4f {
-  let l = dot(color.rgb, vec3f(0.2126, 0.7152, 0.0722));
-  return vec4f(l * 0.12, l * 0.95, l * 0.35, color.a);
-}
-`,
-  },
-});
-
-stage.setEnabled(false);
-restty.removeShaderStage("app/mono");
-```
-
-### xterm compatibility layer
-
-For migration from xterm.js-style app code, use `restty/xterm`:
-
-```ts
-import { Terminal } from "restty/xterm";
-
-const term = new Terminal({ cols: 100, rows: 30 });
-term.open(document.getElementById("terminal") as HTMLElement);
-
-term.onData((data) => console.log("input", data));
-term.onResize(({ cols, rows }) => console.log("resize", cols, rows));
-
-term.write("hello");
-term.writeln(" world");
-term.resize(120, 40);
-term.loadAddon({
-  activate() {},
-  dispose() {},
-});
-```
-
-Compatibility scope:
-
-- Good for common embed/migration flows.
-- Not full xterm internals parity (buffer/parser/marker ecosystem APIs are not all implemented).
-- Prefer native `Restty` API for long-term integrations.
-
-## API Snapshot
-
-Primary class:
-
-- `new Restty({ root, ...options })`
-- `createRestty(options)`
-
-Xterm compatibility:
-
-- `import { Terminal } from "restty/xterm"`
-- Supports `open`, `write`, `writeln`, `resize`, `focus`, `blur`, `clear`, `reset`, `onData`, `onResize`, `options`, `loadAddon`, `dispose`
-
-Pane access:
-
-- `panes()` / `pane(id)` / `activePane()` / `focusedPane()` / `forEachPane(visitor)`
-- `splitActivePane("vertical" | "horizontal")` / `splitPane(id, direction)` / `closePane(id)`
-
-Active-pane convenience:
-
-- `connectPty(url)` / `disconnectPty()` / `isPtyConnected()`
-- `setRenderer("auto" | "webgpu" | "webgl2")`
-- `setFontSize(number)` / `setFontSources([...])`
-- `applyTheme(theme)` / `resetTheme()`
-- `setMouseMode("auto" | "on" | "off")`
-- `sendInput(text)` / `sendKeyInput(text)`
-- `copySelectionToClipboard()` / `pasteFromClipboard()`
-- `resize(cols, rows)` / `focus()` / `blur()`
-- `updateSize(force?)`
-- `destroy()`
-
-Plugin host:
-
-- `use(plugin, options?)` / `loadPlugins(manifest, registry)` / `unuse(pluginId)` / `plugins()` / `pluginInfo(pluginId?)`
-- plugin context supports `on(...)`, `addInputInterceptor(...)`, `addOutputInterceptor(...)`, `addLifecycleHook(...)`, `addRenderHook(...)`, `addRenderStage(...)`
-
-Shader stages:
-
-- `setShaderStages(stages)` / `getShaderStages()`
-- `addShaderStage(stage)` / `removeShaderStage(id)`
-
-## Advanced / Internal Modules
-
-Use these only when you need lower-level control:
-
-- `restty/internal`: full internal barrel (unstable; includes low-level modules like WASM/input/pty helpers)
+- [Getting started](https://restty.pages.dev/docs/getting-started)
+- [Core concepts](https://restty.pages.dev/docs/core-concepts)
+- [Surface and panes](https://restty.pages.dev/docs/surface-and-panes)
+- [Configuration](https://restty.pages.dev/docs/configuration)
+- [PTY backends](https://restty.pages.dev/docs/pty-backends)
+- [Headless terminal](https://restty.pages.dev/docs/headless)
+- [Search](https://restty.pages.dev/docs/search)
+- [Playground examples](https://restty.pages.dev/docs/playground-examples)
+- [Fonts](https://restty.pages.dev/docs/fonts)
+- [Themes and shaders](https://restty.pages.dev/docs/themes)
+- [Plugins](https://restty.pages.dev/docs/plugins)
+- [xterm compatibility](https://restty.pages.dev/docs/xterm-compat)
+- [Troubleshooting](https://restty.pages.dev/docs/troubleshooting)
+- [Architecture](https://restty.pages.dev/docs/architecture)
+- [Runnable examples](./examples)
 
 ## Local Development
 
@@ -343,31 +82,23 @@ bun run playground
 
 Open `http://localhost:5173`.
 
-## Code Layout
-
-- `src/surface/`: public API (`Restty`), pane manager orchestration, plugin host, xterm shim.
-- `src/runtime/`: terminal runtime/render loop implementation.
-- `src/renderer/`, `src/input/`, `src/pty/`, `src/fonts/`, `src/theme/`, `src/wasm/`, `src/selection/`: subsystem modules.
-- `src/app/`: compatibility re-export layer while internals are refactored.
-
-## Repository Commands
+Useful checks:
 
 ```bash
-bun run build         # build package output
-bun run test          # full tests
-bun run test:ci       # CI-safe test target
-bun run lint          # lint
-bun run format:check  # formatting check
-bun run build:assets  # static playground bundle (playground/public/playground.js)
-bun run playground    # one-command local dev (PTY + playground dev server)
-bun run pty           # PTY websocket server only
+bun run build
+bun run test:ci
+bun run lint
+bun run format:check
+bun run playground:build
 ```
 
-## Documentation
+Cloudflare Pages deployment settings:
+
+- Framework preset: `None`
+- Build command: `bun install --frozen-lockfile && bun run pages:build`
+- Build output directory: `playground/dist`
+- Root directory: leave blank
+- Environment variables: set `SKIP_DEPENDENCY_INSTALL=1` when using the build command above.
 
-- `docs/README.md` - docs index
-- `docs/usage.md` - practical integration guide
-- `docs/xterm-compat.md` - xterm migration shim
-- `docs/how-it-works.md` - runtime flow
-- `docs/internals/` - implementation notes and architecture
-- `THIRD_PARTY_NOTICES.md` - third-party credits and notices
+The hosted docs are sourced from `playground/content/docs/`. Repository notes under `docs/` are
+legacy/internal references for development context.