restty 0.1.10 → 0.1.12

package/README.md

@@ -1,11 +1,5 @@
 # restty
 
-[![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)
-
 Powerful, lightweight browser terminal. Batteries included.
 
 Live demo: `https://restty.pages.dev/`
@@ -21,32 +15,27 @@ Powered by:
 npm i restty
 ```
 
-## Minimal setup
-
-`restty` auto-creates panes, canvas, and hidden IME inputs for you.
+## Quick Start
 
 ```html
-<div id="termRoot"></div>
+<div id="terminal"></div>
 ```
 
 ```ts
 import { Restty } from "restty";
 
 const restty = new Restty({
-  root: document.getElementById("termRoot") as HTMLElement,
+  root: document.getElementById("terminal") as HTMLElement,
 });
-```
-
-By default, `restty` loads fonts from CDN URLs. You can override them at init via typed `fontSources`.
-
-## Common examples
-
-### Connect to a PTY websocket
 
-```ts
 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
@@ -56,44 +45,65 @@ const theme = getBuiltinTheme("Aizen Dark");
 if (theme) restty.applyTheme(theme);
 ```
 
-### Parse and apply a custom Ghostty theme
+### Parse and apply a Ghostty theme file
 
 ```ts
 import { parseGhosttyTheme } from "restty";
 
-const themeText = `
+const theme = parseGhosttyTheme(`
 foreground = #c0caf5
 background = #1a1b26
 cursor-color = #c0caf5
-`;
-restty.applyTheme(parseGhosttyTheme(themeText), "inline");
+`);
+
+restty.applyTheme(theme, "inline");
+```
+
+### Split panes and operate per pane
+
+```ts
+restty.splitActivePane("vertical");
+restty.splitActivePane("horizontal");
+
+for (const pane of restty.panes()) {
+  pane.connectPty("ws://localhost:8787/pty");
+}
 ```
 
-### Send input manually
+### Use active-pane convenience methods
 
 ```ts
+restty.setFontSize(15);
 restty.sendInput("ls -la\n");
+restty.copySelectionToClipboard();
 ```
 
-### Provide custom fonts on init
+### Provide custom fonts
+
+By default, restty uses a CDN font preset. To fully control fonts, disable the preset and pass `fontSources`.
 
 ```ts
 const restty = new Restty({
-  root: document.getElementById("termRoot") as HTMLElement,
+  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",
     },
   ],
 });
 ```
 
-### Switch fonts at runtime (all panes)
+Update fonts at runtime (all panes):
 
 ```ts
 await restty.setFontSources([
@@ -105,69 +115,36 @@ await restty.setFontSources([
 ]);
 ```
 
-## Multi-pane + Context Menu Defaults
-
-`restty` ships a pane manager and a default terminal context menu so you can add split panes quickly.
-It auto-creates pane DOM, canvas, and hidden IME inputs for you.
-Pane/split/divider styles are injected by the library (no separate CSS file required).
-
-```ts
-import {
-  Restty,
-  getBuiltinTheme,
-} from "restty";
-
-const root = document.getElementById("paneRoot") as HTMLElement;
-
-const restty = new Restty({
-  root,
-  appOptions: {
-    renderer: "auto",
-    fontSize: 18,
-    callbacks: {
-      onLog: (line) => console.log(line),
-    },
-    elements: {},
-  },
-  defaultContextMenu: {
-    getPtyUrl: () => "ws://localhost:8787/pty",
-  },
-  paneStyles: {
-    inactivePaneOpacity: 0.82,
-    dividerThicknessPx: 1,
-  },
-  shortcuts: true,
-});
-
-const first = restty.getActivePane();
-const theme = getBuiltinTheme("Aizen Dark");
-if (theme && first) first.app.applyTheme(theme);
-```
-
-Default split shortcuts are enabled:
-- `Cmd/Ctrl + D` split right
-- `Cmd/Ctrl + Shift + D` split down
-
-## Restty API
+## API Snapshot
 
-Main methods:
+Primary class:
 - `new Restty({ root, ...options })`
-- `destroy()`
-- `getPanes()` / `getActivePane()` / `getFocusedPane()`
+- `createRestty(options)`
+
+Pane access:
+- `panes()` / `pane(id)` / `activePane()` / `focusedPane()` / `forEachPane(visitor)`
 - `splitActivePane("vertical" | "horizontal")` / `splitPane(id, direction)` / `closePane(id)`
-- `getPaneStyleOptions()` / `setPaneStyleOptions({...})`
+
+Active-pane convenience:
 - `connectPty(url)` / `disconnectPty()` / `isPtyConnected()`
 - `setRenderer("auto" | "webgpu" | "webgl2")`
-- `setFontSize(number)`
+- `setFontSize(number)` / `setFontSources([...])`
 - `applyTheme(theme)` / `resetTheme()`
 - `setMouseMode("auto" | "on" | "off")`
 - `sendInput(text)` / `sendKeyInput(text)`
 - `copySelectionToClipboard()` / `pasteFromClipboard()`
 - `updateSize(force?)`
+- `destroy()`
 
-Low-level ABI access is available via `loadResttyWasm()` when you need direct render-state integration.
+## Advanced / Internal Modules
 
-## Local development
+Use these only when you need lower-level control:
+- `restty/wasm`: low-level WASM ABI wrapper (`loadResttyWasm`, `ResttyWasm`)
+- `restty/input`: key/mouse/input encoding utilities
+- `restty/pty`: PTY transport helpers
+- `restty/internal`: full internal barrel (unstable)
+
+## Local Development
 
 ```bash
 git clone https://github.com/wiedymi/restty.git
@@ -182,36 +159,23 @@ bun run playground
 
 Open `http://localhost:5173`.
 
-Static deploy (Cloudflare Pages):
-- Build: `bun run build:assets`
-- Output directory: `playground/public`
-- Keep `_headers` in that folder for COOP/COEP (required by WebContainer mode).
-
-## Commands (repo)
+## Repository Commands
 
 ```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 (src only)
+bun run format:check  # formatting check
 bun run build:assets  # playground bundles
-bun run pty           # local PTY server
+bun run pty           # local PTY websocket server
 bun run playground    # playground dev server
-./test.sh             # static terminal capability sweep
-./demo.sh             # animated terminal demo (good for WebContainer demos)
 ```
 
-## Acknowledgements
-
-Huge thanks to the Ghostty project and contributors for `libghostty-vt`, which powers restty's terminal core.
-
-`text-shaper` is my own library, and it also makes this project possible by handling shaping and glyph rasterization in the browser pipeline.
-
-## Docs
+## Documentation
 
 - `docs/README.md` - docs index
-- `docs/usage.md` - integration details
+- `docs/usage.md` - practical integration guide
 - `docs/how-it-works.md` - runtime flow
-- `docs/internals/` - architecture docs
+- `docs/internals/` - implementation notes and architecture
 - `THIRD_PARTY_NOTICES.md` - third-party credits and notices

package/dist/app/font-sources.d.ts

@@ -0,0 +1,3 @@
+import type { ResttyFontPreset, ResttyFontSource } from "./types";
+export declare const DEFAULT_FONT_SOURCES: ResttyFontSource[];
+export declare function normalizeFontSources(sources: ResttyFontSource[] | undefined, preset: ResttyFontPreset | undefined): ResttyFontSource[];