@otoji/core 0.0.0-placeholder → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Snowstar Miao
+
+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,5 +1,69 @@
-# @otoji/core
+# otoji (音字)
 
-Placeholder so the npm name exists. The real binding will be published by
-[release.yml](https://github.com/snomiao/otoji/blob/main/.github/workflows/release.yml)
-on the next conventional-commits release.
+> realtime speech ⇄ text — *音を字に*
+
+`otoji` is a Rust workspace that wires up streaming ASR, LLM-polished transcripts, and TTS behind a single `react-ink`-style terminal UI built on [`ratatui`](https://ratatui.rs).
+
+```text
+mic / file ──► AudioChunk ──► AsrProvider ──► AsrEvent ──► Polisher ──► TUI
+                                                                    └─► transcript.md
+```
+
+## Workspace layout
+
+| Crate | Purpose |
+|---|---|
+| `otoji-core` | Shared types: `AudioChunk`, `AsrEvent`, `Word`, `OtojiError` |
+| `otoji-audio` | Audio sources — `cpal` mic capture (with resampling) and PCM file replay |
+| `otoji-asr` | `AsrProvider` trait + `iflytek_rtasr` (HMAC-SHA1 signa, WebSocket) |
+| `otoji-tts` | `TtsProvider` trait + `iflytek_tts` (HMAC-SHA256 auth, MP3/PCM streaming) |
+| `otoji-polish` | `Polisher` trait + `NoopPolisher` and `AnthropicPolisher` (Claude Haiku 4.5 default) |
+| `otoji-cli` | `otoji` binary — clap subcommands + ratatui TUI |
+
+See [`./docs/`](./docs/README.md) for the architecture rationale and the comparison of RT ASR providers (iFlytek RTASR / CoLi / SenseVoice / Whisper / Deepgram).
+
+## Build
+
+```bash
+cargo build --release
+```
+
+## Usage
+
+```bash
+# 1) Live mic → RTASR → polished TUI
+export IFLYTEK_APP_ID=...
+export IFLYTEK_API_KEY=...
+export ANTHROPIC_API_KEY=...   # optional, enables LLM polish layer
+cargo run -p otoji-cli -- listen
+
+# 2) Replay a 16kHz mono PCM file in real time
+cargo run -p otoji-cli -- file 16k_10.pcm
+
+# 3) Synthesize speech via iFlytek TTS
+export IFLYTEK_TTS_API_KEY=...
+export IFLYTEK_TTS_API_SECRET=...
+cargo run -p otoji-cli -- speak "你好，世界" --out hello.mp3
+```
+
+## TUI
+
+The transcript view shows:
+
+- `[seg_id]` confirmed segments in **white bold** (polished) or **gray** (raw, awaiting polish)
+- The current partial hypothesis as `░ ...` in dark gray italic
+- A header with provider state and counts
+
+Press `q` / `Esc` / `Ctrl-C` to quit.
+
+## Roadmap
+
+- [ ] `otoji-asr/coli.rs` — CoLi ASR via ListenHub
+- [ ] `otoji-asr/sensevoice.rs` — FunASR self-host bridge
+- [ ] `otoji-tts/edge_tts.rs` — Microsoft Edge TTS as a free fallback
+- [ ] `otoji-cli record` — write transcripts to `*.md` next to the source audio
+- [ ] Bench harness (CER / latency / cost) under `crates/otoji-bench`
+
+## License
+
+MIT

package/main.d.ts

@@ -0,0 +1,14 @@
+// Re-export the napi-rs generated types and add the wrapper-only helpers.
+export {
+  PolishOptions,
+  TranscribeOptions,
+  polishText,
+  transcribePcm,
+} from "./index";
+
+/** True if the platform-specific native binding loaded successfully. */
+export declare function isNativeAvailable(): boolean;
+
+/** The error captured the last time we tried to load the native binding,
+ *  or `null` if it loaded successfully. */
+export declare function nativeLoadError(): Error | null;

package/main.js

@@ -0,0 +1,107 @@
+// @otoji/core entry — wraps the napi-rs native binding with a portable
+// fallback so `npm install @otoji/core` works on every platform, even
+// the ones we don't ship a prebuilt `.node` for.
+//
+// Resolution order:
+//   1. Try to load the native binding (./index.js generated by napi-rs;
+//      it picks the right `core.<triple>.node` or `@otoji/core-<triple>`
+//      sub-package for process.platform/arch).
+//   2. On failure (unsupported OS/arch, missing optional dep, etc.),
+//      fall back to a pure-JS implementation.
+//
+// Fallback support:
+//   - polishText:    full — calls Anthropic via global fetch.
+//   - transcribePcm: not implementable without sherpa-onnx; throws a
+//                    descriptive error pointing the user at the
+//                    supported native targets.
+
+"use strict";
+
+let native = null;
+let nativeLoadError = null;
+try {
+  // eslint-disable-next-line global-require
+  native = require("./index.js");
+} catch (e) {
+  nativeLoadError = e;
+}
+
+const SUPPORTED = [
+  "darwin-arm64",
+  "darwin-x64",
+  "linux-x64-gnu",
+  "win32-x64-msvc",
+];
+
+const ANTHROPIC_URL = "https://api.anthropic.com/v1/messages";
+
+async function polishTextFallback(opts) {
+  if (!opts || !opts.apiKey) {
+    throw new TypeError("polishText: opts.apiKey is required");
+  }
+  if (typeof opts.raw !== "string") {
+    throw new TypeError("polishText: opts.raw must be a string");
+  }
+  if (typeof fetch !== "function") {
+    throw new Error(
+      "@otoji/core JS fallback needs a global `fetch` (Node 18+ / Bun / Deno)"
+    );
+  }
+  const model = opts.model || "claude-haiku-4-5-20251001";
+  const prev = opts.prev || "(none)";
+  const system =
+    "You tidy ASR transcripts.\n" +
+    "- Preserve meaning. Do not summarize.\n" +
+    "- Add punctuation, drop fillers (uh/um/那个/えーと).\n" +
+    "- Normalize numbers, dates, units.\n" +
+    "- Keep code-switched text (zh/en/ja) as-is.\n" +
+    `- Previous sentence: ${prev}\n` +
+    "Output only the tidied sentence.";
+  const res = await fetch(ANTHROPIC_URL, {
+    method: "POST",
+    headers: {
+      "x-api-key": opts.apiKey,
+      "anthropic-version": "2023-06-01",
+      "content-type": "application/json",
+    },
+    body: JSON.stringify({
+      model,
+      max_tokens: 512,
+      system,
+      messages: [{ role: "user", content: opts.raw }],
+    }),
+  });
+  if (!res.ok) {
+    const body = await res.text().catch(() => "");
+    throw new Error(`anthropic ${res.status}: ${body}`);
+  }
+  const data = await res.json();
+  return data.content
+    .map((b) => b.text || "")
+    .join("")
+    .trim();
+}
+
+function transcribePcmFallback() {
+  const platform = `${process.platform}-${process.arch}`;
+  const reason = nativeLoadError ? ` (${nativeLoadError.message})` : "";
+  throw new Error(
+    `@otoji/core: transcribePcm requires the native binding, which is not ` +
+      `available for ${platform}${reason}. ` +
+      `Supported native targets: ${SUPPORTED.join(", ")}. ` +
+      `polishText still works via the JS fallback.`
+  );
+}
+
+module.exports.polishText =
+  native && typeof native.polishText === "function"
+    ? native.polishText
+    : polishTextFallback;
+
+module.exports.transcribePcm =
+  native && typeof native.transcribePcm === "function"
+    ? native.transcribePcm
+    : transcribePcmFallback;
+
+module.exports.isNativeAvailable = () => native !== null;
+module.exports.nativeLoadError = () => nativeLoadError;

package/package.json

@@ -1,11 +1,50 @@
 {
   "name": "@otoji/core",
-  "version": "0.0.0-placeholder",
-  "description": "Placeholder for otoji native bindings — will be replaced by the next release.yml run.",
+  "version": "0.1.1",
+  "description": "音字 — realtime speech ⇄ text. Node/Bun bindings for the otoji Rust crate (SenseVoice ASR + Anthropic polish).",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/snomiao/otoji.git"
   },
-  "homepage": "https://github.com/snomiao/otoji"
+  "main": "main.js",
+  "types": "main.d.ts",
+  "files": [
+    "main.js",
+    "main.d.ts",
+    "index.js",
+    "index.d.ts",
+    "*.node"
+  ],
+  "napi": {
+    "name": "core",
+    "package": {
+      "name": "@otoji/core"
+    },
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "x86_64-pc-windows-msvc",
+        "x86_64-apple-darwin",
+        "aarch64-apple-darwin",
+        "x86_64-unknown-linux-gnu"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "napi build --platform --release --features node --cargo-flags=--lib",
+    "build:debug": "napi build --platform --features node --cargo-flags=--lib"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "optionalDependencies": {
+    "@otoji/core-darwin-arm64": "0.1.1",
+    "@otoji/core-darwin-x64": "0.1.1",
+    "@otoji/core-linux-x64-gnu": "0.1.1",
+    "@otoji/core-win32-x64-msvc": "0.1.1"
+  }
 }