bell-reader 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BELL contributors
+
+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.

package/README.md

@@ -1,3 +1,76 @@
-# Temporary Holding Version
+# BELL Web Reader
 
-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.
+**English** · [繁體中文](./README.zh-TW.md)
+
+Local-first web article snapshot and organic ink annotation reader. Capture public HTTPS articles (with DNS-pinned SSRF protection) or paste Markdown/prose into a clean offline SQLite library, then annotate directly on the page with hand-drawn SVG highlights, underlines, boxes, brackets, margin notes, and sketches.
+
+Runs out-of-the-box as an **independent Standalone App** (zero environment variables required) or as part of **[BELL Suite](https://github.com/Suzu1Dev/bell-suite)** alongside Personal, Explain, BELL PR, and Campaign.
+
+## Quick Start
+
+### Install in One Line (macOS / Linux / WSL)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/Suzu1Dev/bell-reader/main/install.sh | sh
+bell-reader
+```
+
+The installer checks npm first and automatically falls back to cloning from GitHub (`~/.local/share/bell-reader/app`) and symlinking `~/.local/bin/bell-reader`, bootstrapping Node.js 24 if needed.
+
+### Windows (PowerShell)
+
+```powershell
+irm https://raw.githubusercontent.com/Suzu1Dev/bell-reader/main/install.ps1 | iex
+bell-reader
+```
+
+### Run via `npx` or From Source
+
+```bash
+# Run directly with npx
+npx bell-reader
+
+# Or clone and run from source
+git clone https://github.com/Suzu1Dev/bell-reader.git
+cd bell-reader
+npm install && npm run build
+./bin/bell-reader.mjs start
+```
+
+## CLI Usage
+
+```text
+bell-reader [start] [--port <n>] [--host <h>] [--no-open] [--suite]
+bell-reader doctor [--json]
+bell-reader --version | --help
+```
+
+- **Standalone Edition (default)**: listens on `http://127.0.0.1:4630` with local SQLite storage in `./data/` (checkout) or `~/.bell-reader/data/` (global install).
+- **BELL Suite Edition (`--suite` or `bell-suite start`)**: listens on `http://127.0.0.1:4604`, matches reading topics against local BELL Explain notes, accepts `#/read?text=...` handoffs, and sends pages/annotations to BELL Explain (`#/explain`), BELL Personal (`#/tasks`), or BELL PR (`#/discover`).
+
+## Architecture Overview
+
+```text
+bin/bell-reader.mjs    Standalone & Suite CLI (start, doctor, --version, --help)
+src/                   React 19 editorial reader, Range-anchored RoughJS/freehand ink stage,
+                       margin cards, bilingual translation view, and Suite switcher
+shared/                TypeScript page/annotation schemas and Suite Contract v1 routes
+server/                Express 5 API, SSRF-hardened HTML extractor, SQLite store (node:sqlite),
+                       optional AI doodle/selection/translation runners, Explain topic bridge
+Formula/               Homebrew formula template
+```
+
+## Development & Verification
+
+Requires **Node.js 22.13+** (Node.js 24 LTS recommended) for built-in `node:sqlite`.
+
+```bash
+npm install
+npm run dev        # Vite frontend + API watch
+npm test           # Unit & integration test suite
+npm run build      # TypeScript check + production Vite bundle
+```
+
+## License
+
+[MIT](./LICENSE)

package/README.zh-TW.md

@@ -0,0 +1,55 @@
+# BELL Web Reader
+
+[English](./README.md) · **繁體中文**
+
+本機優先的網頁擷取與紙上手繪塗鴉標註閱讀器：擷取公開 HTTPS 文章或貼上 Markdown／文字為離線閱讀快照，疊加有機手繪螢光筆、波浪線、圈選框與頁邊批註卡。可單獨執行（Standalone Edition），也可與 [BELL Suite](https://github.com/Suzu1Dev/bell-suite)（Personal、Explain、PR、Campaign）串聯運作。
+
+## 一鍵安裝與 CLI 啟動
+
+```bash
+# macOS / Linux / WSL
+curl -fsSL https://raw.githubusercontent.com/Suzu1Dev/bell-reader/main/install.sh | sh
+bell-reader
+
+# 或直接透過 npx 啟動
+npx bell-reader
+```
+
+Windows PowerShell：
+
+```powershell
+irm https://raw.githubusercontent.com/Suzu1Dev/bell-reader/main/install.ps1 | iex
+bell-reader
+```
+
+常用 CLI 指令：
+
+```bash
+bell-reader start               # 獨立模式啟動（預設 http://127.0.0.1:4630）
+bell-reader start --suite       # BELL Suite 模式啟動（預設 http://127.0.0.1:4604）
+bell-reader doctor              # 檢查 Node、SQLite、資料目錄與選用 AI CLI 狀態
+```
+
+## 核心設計
+
+1. **乾淨閱讀快照 ＋ 動態錨點 SVG 塗鴉層**：
+   - 後端以 SSRF 防護（DNS 釘定公開 IP、禁止內網與重新導向濫用）擷取公開 HTTPS 網頁正文、程式碼與附圖，或直接解析貼上的文章／Markdown，離線保存於本機 SQLite（`data/bell-reader.sqlite`）。
+   - 前端不破壞內容排版，以 `Range.getClientRects()` 綁定精確文字範圍，即時疊加有機手繪 SVG 圖層（螢光筆 `highlight`、波浪線 `underline`、圈選框 `box`、段落括號 `bracket`）與跨欄手繪曲線箭頭，連至右側手寫風格頁邊批註卡。
+2. **保存即快取，不重複燒 Token**：
+   - 已讀取的網址再次輸入時直接載入本機快照與既有標註；重新開啟頁面 0 AI 呼叫。
+   - 支援整頁一鍵「AI 塗鴉標註」、雙語翻譯、選取單句「AI 說明」或 0 Token「手寫批註」。
+3. **資料夾歸納 ＋ BELL Suite 雙向交接**：
+   - 支援將頁面與批註透過 Suite 契約送到 **BELL Explain**（`#/explain`）、**BELL Personal**（`#/tasks`）或 **BELL PR**（`#/discover`），並接收來自姊妹應用的 `#/read?text=...` 閱讀交接。
+
+## 開發與測試
+
+```bash
+npm install
+npm run dev
+npm test
+npm run build
+```
+
+## 授權
+
+[MIT](./LICENSE)

package/bin/bell-reader.mjs

@@ -0,0 +1,202 @@
+#!/usr/bin/env node
+import { spawn, spawnSync } from "node:child_process";
+import { existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const rootDir = resolve(dirname(fileURLToPath(import.meta.url)), "..");
+const pkg = JSON.parse(readFileSync(join(rootDir, "package.json"), "utf8"));
+
+const HELP = `BELL Web Reader v${pkg.version} — Local-first web snapshot & ink annotation reader
+
+Usage:
+  bell-reader [start] [options]    Start BELL Web Reader locally
+  bell-reader doctor [--json]      Verify Node, SQLite, data dir, and AI CLIs
+  bell-reader --version, -v        Print version
+  bell-reader --help, -h           Show this help
+
+Options (start):
+  --port <n>      Port to listen on (default: 4630 standalone, 4604 with --suite)
+  --host <host>   Host to bind (default: 127.0.0.1)
+  --no-open       Do not open the browser automatically
+  --suite         Enable BELL Suite edition with default local sibling links
+`;
+
+function parseArgs(argv) {
+  const opts = { cmd: "start", port: undefined, host: undefined, open: true, suite: false, json: false };
+  const rest = [...argv];
+  if (rest[0] && !rest[0].startsWith("-")) {
+    opts.cmd = rest.shift();
+  }
+  while (rest.length > 0) {
+    const arg = rest.shift();
+    if (arg === "--help" || arg === "-h") { opts.cmd = "help"; }
+    else if (arg === "--version" || arg === "-v") { opts.cmd = "version"; }
+    else if (arg === "--no-open") { opts.open = false; }
+    else if (arg === "--suite") { opts.suite = true; }
+    else if (arg === "--json") { opts.json = true; }
+    else if (arg === "--port" && rest.length > 0) { opts.port = Number(rest.shift()); }
+    else if (arg.startsWith("--port=")) { opts.port = Number(arg.slice(7)); }
+    else if (arg === "--host" && rest.length > 0) { opts.host = rest.shift(); }
+    else if (arg.startsWith("--host=")) { opts.host = arg.slice(7); }
+    else { throw new Error(`Unknown or incomplete option: ${arg}`); }
+  }
+  return opts;
+}
+
+function defaultDataDir() {
+  if (process.env.BELL_READER_DATA_DIR) return resolve(process.env.BELL_READER_DATA_DIR);
+  if (existsSync(join(rootDir, "data")) || existsSync(join(rootDir, ".git"))) return join(rootDir, "data");
+  return join(homedir(), ".bell-reader", "data");
+}
+
+function checkCmd(bin, args = ["--version"]) {
+  const res = spawnSync(bin, args, { encoding: "utf8", timeout: 4000, stdio: ["ignore", "pipe", "pipe"] });
+  return res.status === 0 ? (res.stdout || res.stderr || "").trim().split("\n")[0] : null;
+}
+
+async function runDoctor(json) {
+  const nodeVersion = process.versions.node;
+  const [major] = nodeVersion.split(".").map(Number);
+  const nodeOk = major >= 20;
+  let sqliteOk = false;
+  let sqliteDetail = "unavailable (requires Node >= 22.13)";
+  try {
+    await import("node:sqlite");
+    sqliteOk = true;
+    sqliteDetail = `node:sqlite ready (Node v${nodeVersion})`;
+  } catch (err) {
+    sqliteDetail = err instanceof Error ? err.message : String(err);
+  }
+
+  const dataDir = defaultDataDir();
+  let dataWritable = false;
+  try {
+    mkdirSync(dataDir, { recursive: true });
+    const probe = join(dataDir, `.doctor-${process.pid}`);
+    writeFileSync(probe, "ok");
+    unlinkSync(probe);
+    dataWritable = true;
+  } catch {}
+
+  const distReady = existsSync(join(rootDir, "dist", "index.html"));
+  const codex = checkCmd("codex");
+  const claude = checkCmd("claude");
+
+  const checks = [
+    { name: "node", ok: nodeOk && sqliteOk, detail: sqliteOk ? `v${nodeVersion} (${sqliteDetail})` : `v${nodeVersion} — ${sqliteDetail}` },
+    { name: "dataDir", ok: dataWritable, detail: dataDir },
+    { name: "frontendBuild", ok: distReady, detail: distReady ? join(rootDir, "dist") : "not built yet (auto-builds on start)" },
+    {
+      name: "aiProvider",
+      ok: true,
+      detail: [codex ? `codex (${codex})` : null, claude ? `claude (${claude})` : null].filter(Boolean).join(", ")
+        || "none detected (web capture, offline reading, and manual ink annotations work without AI)",
+    },
+  ];
+  const ok = checks.every(c => c.ok || c.name === "frontendBuild");
+  if (json) {
+    console.log(JSON.stringify({ app: "bell-reader", version: pkg.version, ok, checks }, null, 2));
+  } else {
+    console.log(`BELL Web Reader v${pkg.version} doctor\n`);
+    for (const c of checks) {
+      const mark = c.ok ? "[OK]" : c.name === "frontendBuild" ? "[WARN]" : "[FAIL]";
+      console.log(`  ${mark} ${c.name.padEnd(15)} ${c.detail}`);
+    }
+    console.log(ok ? "\nReady to start: bell-reader start" : "\nFix the failing checks above before starting.");
+  }
+  process.exit(ok ? 0 : 1);
+}
+
+function canOpenBrowser(openFlag) {
+  if (!openFlag || process.env.CI || process.env.SSH_CONNECTION || process.env.SSH_TTY) return false;
+  if (process.platform === "linux" && !process.env.DISPLAY && !process.env.WAYLAND_DISPLAY) return false;
+  return true;
+}
+
+function openBrowser(url) {
+  const cmd = process.platform === "darwin" ? "open" : process.platform === "win32" ? "cmd" : "xdg-open";
+  const args = process.platform === "win32" ? ["/c", "start", "", url] : [url];
+  const child = spawn(cmd, args, { stdio: "ignore", detached: true });
+  child.on("error", () => {});
+  child.unref();
+}
+
+async function waitAndOpen(url, openFlag) {
+  for (let i = 0; i < 40; i++) {
+    try {
+      const res = await fetch(`${url}/api/health`);
+      if (res.ok) {
+        if (canOpenBrowser(openFlag)) openBrowser(url);
+        return;
+      }
+    } catch {}
+    await new Promise(r => setTimeout(r, 250));
+  }
+}
+
+async function runStart(opts) {
+  const distIndex = join(rootDir, "dist", "index.html");
+  if (!existsSync(distIndex)) {
+    console.log("Building BELL Web Reader frontend (dist/)...");
+    const npmCmd = process.platform === "win32" ? "npm.cmd" : "npm";
+    const build = spawnSync(npmCmd, ["run", "build"], { cwd: rootDir, stdio: "inherit" });
+    if (build.status !== 0) process.exit(build.status ?? 1);
+  }
+
+  const suiteMode = opts.suite || process.env.BELL_READER_EDITION === "suite" || Boolean(process.env.BELL_READER_SUITE_LINKS?.trim());
+  const port = opts.port ?? (process.env.BELL_READER_PORT || process.env.PORT ? Number(process.env.BELL_READER_PORT || process.env.PORT) : suiteMode ? 4604 : 4630);
+  const host = opts.host ?? process.env.BELL_READER_HOST ?? process.env.HOST ?? "127.0.0.1";
+  if (!Number.isInteger(port) || port < 1 || port > 65535) {
+    throw new Error(`Invalid port: ${port}`);
+  }
+
+  const dataDir = defaultDataDir();
+  mkdirSync(dataDir, { recursive: true });
+
+  const env = {
+    ...process.env,
+    HOST: host,
+    PORT: String(port),
+    BELL_READER_HOST: host,
+    BELL_READER_PORT: String(port),
+    BELL_READER_DATA_DIR: dataDir,
+    BELL_READER_EDITION: suiteMode ? "suite" : "standalone",
+  };
+  if (opts.suite && !env.BELL_READER_SUITE_LINKS) {
+    env.BELL_READER_SUITE_LINKS = "personal=http://127.0.0.1:4601,explain=http://127.0.0.1:4602,pr=http://127.0.0.1:4603,campaign=http://127.0.0.1:4605";
+    if (!env.BELL_READER_SUITE_FETCH) {
+      env.BELL_READER_SUITE_FETCH = "explain=http://127.0.0.1:4602,pr=http://127.0.0.1:4603";
+    }
+  }
+
+  const localTsx = join(rootDir, "node_modules", ".bin", process.platform === "win32" ? "tsx.cmd" : "tsx");
+  const bin = existsSync(localTsx) ? localTsx : (process.platform === "win32" ? "npx.cmd" : "npx");
+  const args = existsSync(localTsx)
+    ? ["--env-file-if-exists=.env", "server/index.ts"]
+    : ["tsx", "--env-file-if-exists=.env", "server/index.ts"];
+
+  const browseHost = host === "0.0.0.0" || host === "::" ? "127.0.0.1" : host.includes(":") ? `[${host}]` : host;
+  const url = `http://${browseHost}:${port}`;
+  console.log(`Starting BELL Web Reader (${suiteMode ? "Suite edition" : "Standalone edition"}) at ${url}`);
+
+  const child = spawn(bin, args, { cwd: rootDir, stdio: "inherit", env });
+  for (const sig of ["SIGINT", "SIGTERM"]) {
+    process.on(sig, () => { if (!child.killed) child.kill(sig); });
+  }
+  void waitAndOpen(url, opts.open);
+  child.on("exit", (code) => process.exit(code ?? 0));
+}
+
+try {
+  const opts = parseArgs(process.argv.slice(2));
+  if (opts.cmd === "version") console.log(pkg.version);
+  else if (opts.cmd === "help") console.log(HELP);
+  else if (opts.cmd === "doctor") await runDoctor(opts.json);
+  else if (opts.cmd === "start") await runStart(opts);
+  else throw new Error(`Unknown command: ${opts.cmd}`);
+} catch (err) {
+  console.error(err instanceof Error ? err.message : String(err));
+  process.exit(1);
+}